From 66bd623465940cb1905eba172a8877ebcecea015 Mon Sep 17 00:00:00 2001 From: AWS SDK For Ruby Date: Fri, 9 Feb 2024 19:12:41 +0000 Subject: [PATCH] Updated API models and rebuilt service gems. --- apis/amp/2020-08-01/api-2.json | 428 +++--- apis/amp/2020-08-01/docs-2.json | 570 ++++---- apis/batch/2016-08-10/api-2.json | 13 +- apis/batch/2016-08-10/docs-2.json | 52 +- .../batch/2016-08-10/endpoint-rule-set-1.json | 48 +- apis/braket/2019-09-01/api-2.json | 3 +- .../2022-07-26/api-2.json | 1 + .../2022-07-26/docs-2.json | 5 +- apis/ecs/2014-11-13/docs-2.json | 8 +- apis/iot/2015-05-28/api-2.json | 16 +- apis/iot/2015-05-28/docs-2.json | 18 +- apis/pricing/2017-10-15/api-2.json | 20 +- apis/pricing/2017-10-15/docs-2.json | 8 +- .../2017-10-15/endpoint-rule-set-1.json | 40 +- gems/aws-partitions/CHANGELOG.md | 5 + gems/aws-partitions/VERSION | 2 +- gems/aws-partitions/partitions.json | 6 + gems/aws-sdk-batch/CHANGELOG.md | 5 + gems/aws-sdk-batch/VERSION | 2 +- gems/aws-sdk-batch/lib/aws-sdk-batch.rb | 2 +- .../aws-sdk-batch/lib/aws-sdk-batch/client.rb | 18 +- .../lib/aws-sdk-batch/client_api.rb | 6 + .../lib/aws-sdk-batch/endpoint_provider.rb | 6 +- gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb | 161 ++- gems/aws-sdk-batch/sig/client.rbs | 6 + gems/aws-sdk-batch/sig/types.rbs | 7 + gems/aws-sdk-braket/CHANGELOG.md | 5 + gems/aws-sdk-braket/VERSION | 2 +- gems/aws-sdk-braket/lib/aws-sdk-braket.rb | 2 +- .../lib/aws-sdk-braket/client.rb | 2 +- .../lib/aws-sdk-braket/client_api.rb | 1 + gems/aws-sdk-costoptimizationhub/CHANGELOG.md | 5 + gems/aws-sdk-costoptimizationhub/VERSION | 2 +- .../lib/aws-sdk-costoptimizationhub.rb | 2 +- .../lib/aws-sdk-costoptimizationhub/client.rb | 6 +- .../aws-sdk-costoptimizationhub/client_api.rb | 1 + .../lib/aws-sdk-costoptimizationhub/types.rb | 11 +- .../sig/client.rbs | 1 + .../aws-sdk-costoptimizationhub/sig/types.rbs | 1 + gems/aws-sdk-ecs/CHANGELOG.md | 5 + gems/aws-sdk-ecs/VERSION | 2 +- gems/aws-sdk-ecs/lib/aws-sdk-ecs.rb | 2 +- gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb | 312 ++-- gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb | 267 +++- gems/aws-sdk-iot/CHANGELOG.md | 5 + gems/aws-sdk-iot/VERSION | 2 +- gems/aws-sdk-iot/lib/aws-sdk-iot.rb | 2 +- gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb | 30 +- .../aws-sdk-iot/lib/aws-sdk-iot/client_api.rb | 8 + gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb | 42 +- gems/aws-sdk-iot/sig/client.rbs | 7 + gems/aws-sdk-iot/sig/types.rbs | 8 + gems/aws-sdk-pricing/CHANGELOG.md | 5 + gems/aws-sdk-pricing/VERSION | 2 +- gems/aws-sdk-pricing/lib/aws-sdk-pricing.rb | 2 +- .../lib/aws-sdk-pricing/client.rb | 2 +- .../lib/aws-sdk-pricing/client_api.rb | 9 + .../lib/aws-sdk-pricing/endpoint_provider.rb | 2 +- .../lib/aws-sdk-pricing/errors.rb | 28 + .../lib/aws-sdk-pricing/types.rb | 13 + gems/aws-sdk-pricing/sig/errors.rbs | 3 + gems/aws-sdk-pricing/sig/types.rbs | 5 + gems/aws-sdk-prometheusservice/CHANGELOG.md | 5 + gems/aws-sdk-prometheusservice/VERSION | 2 +- .../lib/aws-sdk-prometheusservice.rb | 2 +- .../lib/aws-sdk-prometheusservice/client.rb | 682 +++++---- .../aws-sdk-prometheusservice/client_api.rb | 140 +- .../lib/aws-sdk-prometheusservice/errors.rb | 30 +- .../lib/aws-sdk-prometheusservice/types.rb | 1281 +++++++++-------- gems/aws-sdk-prometheusservice/sig/client.rbs | 102 +- gems/aws-sdk-prometheusservice/sig/errors.rbs | 6 +- gems/aws-sdk-prometheusservice/sig/types.rbs | 140 +- 72 files changed, 2747 insertions(+), 1903 deletions(-) diff --git a/apis/amp/2020-08-01/api-2.json b/apis/amp/2020-08-01/api-2.json index df11549dd3c..134e9795229 100644 --- a/apis/amp/2020-08-01/api-2.json +++ b/apis/amp/2020-08-01/api-2.json @@ -493,16 +493,16 @@ "AlertManagerDefinitionDescription":{ "type":"structure", "required":[ - "status", - "data", "createdAt", - "modifiedAt" + "data", + "modifiedAt", + "status" ], "members":{ - "status":{"shape":"AlertManagerDefinitionStatus"}, - "data":{"shape":"AlertManagerDefinitionData"}, "createdAt":{"shape":"Timestamp"}, - "modifiedAt":{"shape":"Timestamp"} + "data":{"shape":"AlertManagerDefinitionData"}, + "modifiedAt":{"shape":"Timestamp"}, + "status":{"shape":"AlertManagerDefinitionStatus"} } }, "AlertManagerDefinitionStatus":{ @@ -534,7 +534,7 @@ "Blob":{"type":"blob"}, "ClusterArn":{ "type":"string", - "pattern":"arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+" + "pattern":"^arn:aws[-a-z]*:eks:[-a-z0-9]+:[0-9]{12}:cluster/.+$" }, "ConflictException":{ "type":"structure", @@ -557,19 +557,19 @@ "CreateAlertManagerDefinitionRequest":{ "type":"structure", "required":[ - "workspaceId", - "data" + "data", + "workspaceId" ], "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "data":{"shape":"AlertManagerDefinitionData"}, "workspaceId":{ "shape":"WorkspaceId", "location":"uri", "locationName":"workspaceId" - }, - "data":{"shape":"AlertManagerDefinitionData"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true } } }, @@ -583,19 +583,19 @@ "CreateLoggingConfigurationRequest":{ "type":"structure", "required":[ - "workspaceId", - "logGroupArn" + "logGroupArn", + "workspaceId" ], "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "logGroupArn":{"shape":"LogGroupArn"}, "workspaceId":{ "shape":"WorkspaceId", "location":"uri", "locationName":"workspaceId" - }, - "logGroupArn":{"shape":"LogGroupArn"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true } } }, @@ -609,35 +609,35 @@ "CreateRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ - "workspaceId", + "data", "name", - "data" + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, - "name":{"shape":"RuleGroupsNamespaceName"}, - "data":{"shape":"RuleGroupsNamespaceData"}, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true }, - "tags":{"shape":"TagMap"} + "data":{"shape":"RuleGroupsNamespaceData"}, + "name":{"shape":"RuleGroupsNamespaceName"}, + "tags":{"shape":"TagMap"}, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" + } } }, "CreateRuleGroupsNamespaceResponse":{ "type":"structure", "required":[ - "name", "arn", + "name", "status" ], "members":{ - "name":{"shape":"RuleGroupsNamespaceName"}, "arn":{"shape":"RuleGroupsNamespaceArn"}, + "name":{"shape":"RuleGroupsNamespaceName"}, "status":{"shape":"RuleGroupsNamespaceStatus"}, "tags":{"shape":"TagMap"} } @@ -645,32 +645,32 @@ "CreateScraperRequest":{ "type":"structure", "required":[ + "destination", "scrapeConfiguration", - "source", - "destination" + "source" ], "members":{ "alias":{"shape":"ScraperAlias"}, - "scrapeConfiguration":{"shape":"ScrapeConfiguration"}, - "source":{"shape":"Source"}, - "destination":{"shape":"Destination"}, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true }, + "destination":{"shape":"Destination"}, + "scrapeConfiguration":{"shape":"ScrapeConfiguration"}, + "source":{"shape":"Source"}, "tags":{"shape":"TagMap"} } }, "CreateScraperResponse":{ "type":"structure", "required":[ - "scraperId", "arn", + "scraperId", "status" ], "members":{ - "scraperId":{"shape":"ScraperId"}, "arn":{"shape":"ScraperArn"}, + "scraperId":{"shape":"ScraperId"}, "status":{"shape":"ScraperStatus"}, "tags":{"shape":"TagMap"} } @@ -683,39 +683,39 @@ "shape":"IdempotencyToken", "idempotencyToken":true }, - "tags":{"shape":"TagMap"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "tags":{"shape":"TagMap"} } }, "CreateWorkspaceResponse":{ "type":"structure", "required":[ - "workspaceId", "arn", - "status" + "status", + "workspaceId" ], "members":{ - "workspaceId":{"shape":"WorkspaceId"}, "arn":{"shape":"WorkspaceArn"}, + "kmsKeyArn":{"shape":"KmsKeyArn"}, "status":{"shape":"WorkspaceStatus"}, "tags":{"shape":"TagMap"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} + "workspaceId":{"shape":"WorkspaceId"} } }, "DeleteAlertManagerDefinitionRequest":{ "type":"structure", "required":["workspaceId"], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -723,41 +723,41 @@ "type":"structure", "required":["workspaceId"], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, "DeleteRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ - "workspaceId", - "name" + "name", + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" }, "name":{ "shape":"RuleGroupsNamespaceName", "location":"uri", "locationName":"name" }, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -765,16 +765,16 @@ "type":"structure", "required":["scraperId"], "members":{ - "scraperId":{ - "shape":"ScraperId", - "location":"uri", - "locationName":"scraperId" - }, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "scraperId":{ + "shape":"ScraperId", + "location":"uri", + "locationName":"scraperId" } } }, @@ -793,16 +793,16 @@ "type":"structure", "required":["workspaceId"], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -845,19 +845,19 @@ "DescribeRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ - "workspaceId", - "name" + "name", + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, "name":{ "shape":"RuleGroupsNamespaceName", "location":"uri", "locationName":"name" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -956,7 +956,7 @@ "type":"string", "max":64, "min":1, - "pattern":"[!-~]+" + "pattern":"^[!-~]+$" }, "Integer":{ "type":"integer", @@ -982,16 +982,16 @@ "type":"string", "max":2048, "min":20, - "pattern":"arn:aws:kms:[a-z0-9\\-]+:\\d+:key/[a-f0-9\\-]+" + "pattern":"^arn:aws:kms:[a-z0-9\\-]+:\\d+:key/[a-f0-9\\-]+$" }, "ListRuleGroupsNamespacesRequest":{ "type":"structure", "required":["workspaceId"], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" + "maxResults":{ + "shape":"ListRuleGroupsNamespacesRequestMaxResultsInteger", + "location":"querystring", + "locationName":"maxResults" }, "name":{ "shape":"RuleGroupsNamespaceName", @@ -1003,10 +1003,10 @@ "location":"querystring", "locationName":"nextToken" }, - "maxResults":{ - "shape":"ListRuleGroupsNamespacesRequestMaxResultsInteger", - "location":"querystring", - "locationName":"maxResults" + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -1020,8 +1020,8 @@ "type":"structure", "required":["ruleGroupsNamespaces"], "members":{ - "ruleGroupsNamespaces":{"shape":"RuleGroupsNamespaceSummaryList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "ruleGroupsNamespaces":{"shape":"RuleGroupsNamespaceSummaryList"} } }, "ListScrapersRequest":{ @@ -1031,15 +1031,15 @@ "shape":"ScraperFilters", "location":"querystring" }, - "nextToken":{ - "shape":"PaginationToken", - "location":"querystring", - "locationName":"nextToken" - }, "maxResults":{ "shape":"ListScrapersRequestMaxResultsInteger", "location":"querystring", "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" } } }, @@ -1053,8 +1053,8 @@ "type":"structure", "required":["scrapers"], "members":{ - "scrapers":{"shape":"ScraperSummaryList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "scrapers":{"shape":"ScraperSummaryList"} } }, "ListTagsForResourceRequest":{ @@ -1077,11 +1077,6 @@ "ListWorkspacesRequest":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"PaginationToken", - "location":"querystring", - "locationName":"nextToken" - }, "alias":{ "shape":"WorkspaceAlias", "location":"querystring", @@ -1091,6 +1086,11 @@ "shape":"ListWorkspacesRequestMaxResultsInteger", "location":"querystring", "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "location":"querystring", + "locationName":"nextToken" } } }, @@ -1104,29 +1104,29 @@ "type":"structure", "required":["workspaces"], "members":{ - "workspaces":{"shape":"WorkspaceSummaryList"}, - "nextToken":{"shape":"PaginationToken"} + "nextToken":{"shape":"PaginationToken"}, + "workspaces":{"shape":"WorkspaceSummaryList"} } }, "LogGroupArn":{ "type":"string", - "pattern":"arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:\\d{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*" + "pattern":"^arn:aws[a-z0-9-]*:logs:[a-z0-9-]+:\\d{12}:log-group:[A-Za-z0-9\\.\\-\\_\\#/]{1,512}\\:\\*$" }, "LoggingConfigurationMetadata":{ "type":"structure", "required":[ - "status", - "workspace", - "logGroupArn", "createdAt", - "modifiedAt" + "logGroupArn", + "modifiedAt", + "status", + "workspace" ], "members":{ - "status":{"shape":"LoggingConfigurationStatus"}, - "workspace":{"shape":"WorkspaceId"}, - "logGroupArn":{"shape":"LogGroupArn"}, "createdAt":{"shape":"Timestamp"}, - "modifiedAt":{"shape":"Timestamp"} + "logGroupArn":{"shape":"LogGroupArn"}, + "modifiedAt":{"shape":"Timestamp"}, + "status":{"shape":"LoggingConfigurationStatus"}, + "workspace":{"shape":"WorkspaceId"} } }, "LoggingConfigurationStatus":{ @@ -1156,19 +1156,19 @@ "PutAlertManagerDefinitionRequest":{ "type":"structure", "required":[ - "workspaceId", - "data" + "data", + "workspaceId" ], "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "data":{"shape":"AlertManagerDefinitionData"}, "workspaceId":{ "shape":"WorkspaceId", "location":"uri", "locationName":"workspaceId" - }, - "data":{"shape":"AlertManagerDefinitionData"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true } } }, @@ -1182,38 +1182,38 @@ "PutRuleGroupsNamespaceRequest":{ "type":"structure", "required":[ - "workspaceId", + "data", "name", - "data" + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true }, + "data":{"shape":"RuleGroupsNamespaceData"}, "name":{ "shape":"RuleGroupsNamespaceName", "location":"uri", "locationName":"name" }, - "data":{"shape":"RuleGroupsNamespaceData"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, "PutRuleGroupsNamespaceResponse":{ "type":"structure", "required":[ - "name", "arn", + "name", "status" ], "members":{ - "name":{"shape":"RuleGroupsNamespaceName"}, "arn":{"shape":"RuleGroupsNamespaceArn"}, + "name":{"shape":"RuleGroupsNamespaceName"}, "status":{"shape":"RuleGroupsNamespaceStatus"}, "tags":{"shape":"TagMap"} } @@ -1242,19 +1242,19 @@ "type":"structure", "required":[ "arn", - "name", - "status", - "data", "createdAt", - "modifiedAt" + "data", + "modifiedAt", + "name", + "status" ], "members":{ "arn":{"shape":"RuleGroupsNamespaceArn"}, - "name":{"shape":"RuleGroupsNamespaceName"}, - "status":{"shape":"RuleGroupsNamespaceStatus"}, - "data":{"shape":"RuleGroupsNamespaceData"}, "createdAt":{"shape":"Timestamp"}, + "data":{"shape":"RuleGroupsNamespaceData"}, "modifiedAt":{"shape":"Timestamp"}, + "name":{"shape":"RuleGroupsNamespaceName"}, + "status":{"shape":"RuleGroupsNamespaceStatus"}, "tags":{"shape":"TagMap"} } }, @@ -1262,7 +1262,7 @@ "type":"string", "max":64, "min":1, - "pattern":".*[0-9A-Za-z][-.0-9A-Z_a-z]*.*" + "pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*" }, "RuleGroupsNamespaceStatus":{ "type":"structure", @@ -1287,17 +1287,17 @@ "type":"structure", "required":[ "arn", - "name", - "status", "createdAt", - "modifiedAt" + "modifiedAt", + "name", + "status" ], "members":{ "arn":{"shape":"RuleGroupsNamespaceArn"}, - "name":{"shape":"RuleGroupsNamespaceName"}, - "status":{"shape":"RuleGroupsNamespaceStatus"}, "createdAt":{"shape":"Timestamp"}, "modifiedAt":{"shape":"Timestamp"}, + "name":{"shape":"RuleGroupsNamespaceName"}, + "status":{"shape":"RuleGroupsNamespaceStatus"}, "tags":{"shape":"TagMap"} } }, @@ -1316,35 +1316,35 @@ "type":"string", "max":100, "min":1, - "pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*" + "pattern":"^[0-9A-Za-z][-.0-9A-Z_a-z]*$" }, "ScraperArn":{"type":"string"}, "ScraperDescription":{ "type":"structure", "required":[ - "scraperId", "arn", - "roleArn", - "status", "createdAt", + "destination", "lastModifiedAt", + "roleArn", "scrapeConfiguration", + "scraperId", "source", - "destination" + "status" ], "members":{ "alias":{"shape":"ScraperAlias"}, - "scraperId":{"shape":"ScraperId"}, "arn":{"shape":"ScraperArn"}, - "roleArn":{"shape":"IamRoleArn"}, - "status":{"shape":"ScraperStatus"}, "createdAt":{"shape":"Timestamp"}, + "destination":{"shape":"Destination"}, "lastModifiedAt":{"shape":"Timestamp"}, - "tags":{"shape":"TagMap"}, - "statusReason":{"shape":"StatusReason"}, + "roleArn":{"shape":"IamRoleArn"}, "scrapeConfiguration":{"shape":"ScrapeConfiguration"}, + "scraperId":{"shape":"ScraperId"}, "source":{"shape":"Source"}, - "destination":{"shape":"Destination"} + "status":{"shape":"ScraperStatus"}, + "statusReason":{"shape":"StatusReason"}, + "tags":{"shape":"TagMap"} } }, "ScraperFilters":{ @@ -1358,7 +1358,7 @@ "type":"string", "max":64, "min":1, - "pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*" + "pattern":"^[0-9A-Za-z][-.0-9A-Z_a-z]*$" }, "ScraperStatus":{ "type":"structure", @@ -1380,27 +1380,27 @@ "ScraperSummary":{ "type":"structure", "required":[ - "scraperId", "arn", - "roleArn", - "status", "createdAt", + "destination", "lastModifiedAt", + "roleArn", + "scraperId", "source", - "destination" + "status" ], "members":{ "alias":{"shape":"ScraperAlias"}, - "scraperId":{"shape":"ScraperId"}, "arn":{"shape":"ScraperArn"}, - "roleArn":{"shape":"IamRoleArn"}, - "status":{"shape":"ScraperStatus"}, "createdAt":{"shape":"Timestamp"}, + "destination":{"shape":"Destination"}, "lastModifiedAt":{"shape":"Timestamp"}, - "tags":{"shape":"TagMap"}, - "statusReason":{"shape":"StatusReason"}, + "roleArn":{"shape":"IamRoleArn"}, + "scraperId":{"shape":"ScraperId"}, "source":{"shape":"Source"}, - "destination":{"shape":"Destination"} + "status":{"shape":"ScraperStatus"}, + "statusReason":{"shape":"StatusReason"}, + "tags":{"shape":"TagMap"} } }, "ScraperSummaryList":{ @@ -1411,7 +1411,7 @@ "type":"string", "max":255, "min":0, - "pattern":"sg-[0-9a-z]+" + "pattern":"^sg-[0-9a-z]+$" }, "SecurityGroupIds":{ "type":"list", @@ -1423,17 +1423,17 @@ "type":"structure", "required":[ "message", + "quotaCode", "resourceId", "resourceType", - "serviceCode", - "quotaCode" + "serviceCode" ], "members":{ "message":{"shape":"String"}, + "quotaCode":{"shape":"String"}, "resourceId":{"shape":"String"}, "resourceType":{"shape":"String"}, - "serviceCode":{"shape":"String"}, - "quotaCode":{"shape":"String"} + "serviceCode":{"shape":"String"} }, "error":{ "httpStatusCode":402, @@ -1458,7 +1458,7 @@ "type":"string", "max":255, "min":0, - "pattern":"subnet-[0-9a-z]+" + "pattern":"^subnet-[0-9a-z]+$" }, "SubnetIds":{ "type":"list", @@ -1470,7 +1470,7 @@ "type":"string", "max":128, "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", @@ -1507,20 +1507,20 @@ "type":"string", "max":256, "min":0, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "ThrottlingException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, - "serviceCode":{"shape":"String"}, "quotaCode":{"shape":"String"}, "retryAfterSeconds":{ "shape":"Integer", "location":"header", "locationName":"Retry-After" - } + }, + "serviceCode":{"shape":"String"} }, "error":{ "httpStatusCode":429, @@ -1557,19 +1557,19 @@ "UpdateLoggingConfigurationRequest":{ "type":"structure", "required":[ - "workspaceId", - "logGroupArn" + "logGroupArn", + "workspaceId" ], "members":{ + "clientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + }, + "logGroupArn":{"shape":"LogGroupArn"}, "workspaceId":{ "shape":"WorkspaceId", "location":"uri", "locationName":"workspaceId" - }, - "logGroupArn":{"shape":"LogGroupArn"}, - "clientToken":{ - "shape":"IdempotencyToken", - "idempotencyToken":true } } }, @@ -1584,15 +1584,15 @@ "type":"structure", "required":["workspaceId"], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "location":"uri", - "locationName":"workspaceId" - }, "alias":{"shape":"WorkspaceAlias"}, "clientToken":{ "shape":"IdempotencyToken", "idempotencyToken":true + }, + "workspaceId":{ + "shape":"WorkspaceId", + "location":"uri", + "locationName":"workspaceId" } } }, @@ -1608,9 +1608,9 @@ "reason" ], "members":{ + "fieldList":{"shape":"ValidationExceptionFieldList"}, "message":{"shape":"String"}, - "reason":{"shape":"ValidationExceptionReason"}, - "fieldList":{"shape":"ValidationExceptionFieldList"} + "reason":{"shape":"ValidationExceptionReason"} }, "error":{ "httpStatusCode":400, @@ -1621,12 +1621,12 @@ "ValidationExceptionField":{ "type":"structure", "required":[ - "name", - "message" + "message", + "name" ], "members":{ - "name":{"shape":"String"}, - "message":{"shape":"String"} + "message":{"shape":"String"}, + "name":{"shape":"String"} } }, "ValidationExceptionFieldList":{ @@ -1649,32 +1649,32 @@ }, "WorkspaceArn":{ "type":"string", - "pattern":"arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+" + "pattern":"^arn:aws[-a-z]*:aps:[-a-z0-9]+:[0-9]{12}:workspace/.+$" }, "WorkspaceDescription":{ "type":"structure", "required":[ - "workspaceId", "arn", + "createdAt", "status", - "createdAt" + "workspaceId" ], "members":{ - "workspaceId":{"shape":"WorkspaceId"}, "alias":{"shape":"WorkspaceAlias"}, "arn":{"shape":"WorkspaceArn"}, - "status":{"shape":"WorkspaceStatus"}, - "prometheusEndpoint":{"shape":"Uri"}, "createdAt":{"shape":"Timestamp"}, + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "prometheusEndpoint":{"shape":"Uri"}, + "status":{"shape":"WorkspaceStatus"}, "tags":{"shape":"TagMap"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} + "workspaceId":{"shape":"WorkspaceId"} } }, "WorkspaceId":{ "type":"string", "max":64, "min":1, - "pattern":".*[0-9A-Za-z][-.0-9A-Z_a-z]*.*" + "pattern":"[0-9A-Za-z][-.0-9A-Z_a-z]*" }, "WorkspaceStatus":{ "type":"structure", @@ -1696,19 +1696,19 @@ "WorkspaceSummary":{ "type":"structure", "required":[ - "workspaceId", "arn", + "createdAt", "status", - "createdAt" + "workspaceId" ], "members":{ - "workspaceId":{"shape":"WorkspaceId"}, "alias":{"shape":"WorkspaceAlias"}, "arn":{"shape":"WorkspaceArn"}, - "status":{"shape":"WorkspaceStatus"}, "createdAt":{"shape":"Timestamp"}, + "kmsKeyArn":{"shape":"KmsKeyArn"}, + "status":{"shape":"WorkspaceStatus"}, "tags":{"shape":"TagMap"}, - "kmsKeyArn":{"shape":"KmsKeyArn"} + "workspaceId":{"shape":"WorkspaceId"} } }, "WorkspaceSummaryList":{ diff --git a/apis/amp/2020-08-01/docs-2.json b/apis/amp/2020-08-01/docs-2.json index 636b6664439..9f1b5690ec0 100644 --- a/apis/amp/2020-08-01/docs-2.json +++ b/apis/amp/2020-08-01/docs-2.json @@ -1,244 +1,244 @@ { "version": "2.0", - "service": "

Amazon Managed Service for Prometheus

", + "service": "

Amazon Managed Service for Prometheus is a serverless, Prometheus-compatible monitoring service for container metrics that makes it easier to securely monitor container environments at scale. With Amazon Managed Service for Prometheus, you can use the same open-source Prometheus data model and query language that you use today to monitor the performance of your containerized workloads, and also enjoy improved scalability, availability, and security without having to manage the underlying infrastructure.

For more information about Amazon Managed Service for Prometheus, see the Amazon Managed Service for Prometheus User Guide.

Amazon Managed Service for Prometheus includes two APIs.

", "operations": { - "CreateAlertManagerDefinition": "

Create an alert manager definition.

", - "CreateLoggingConfiguration": "

Create logging configuration.

", - "CreateRuleGroupsNamespace": "

Create a rule group namespace.

", - "CreateScraper": "

Create a scraper.

", - "CreateWorkspace": "

Creates a new AMP workspace.

", - "DeleteAlertManagerDefinition": "

Deletes an alert manager definition.

", - "DeleteLoggingConfiguration": "

Delete logging configuration.

", - "DeleteRuleGroupsNamespace": "

Delete a rule groups namespace.

", - "DeleteScraper": "

Deletes a scraper.

", - "DeleteWorkspace": "

Deletes an AMP workspace.

", - "DescribeAlertManagerDefinition": "

Describes an alert manager definition.

", - "DescribeLoggingConfiguration": "

Describes logging configuration.

", - "DescribeRuleGroupsNamespace": "

Describe a rule groups namespace.

", - "DescribeScraper": "

Describe an existing scraper.

", - "DescribeWorkspace": "

Describes an existing AMP workspace.

", - "GetDefaultScraperConfiguration": "

Gets a default configuration.

", - "ListRuleGroupsNamespaces": "

Lists rule groups namespaces.

", - "ListScrapers": "

Lists all scrapers in a customer account, including scrapers being created or deleted. You may provide filters to return a more specific list of results.

", - "ListTagsForResource": "

Lists the tags you have assigned to the resource.

", - "ListWorkspaces": "

Lists all AMP workspaces, including workspaces being created or deleted.

", - "PutAlertManagerDefinition": "

Update an alert manager definition.

", - "PutRuleGroupsNamespace": "

Update a rule groups namespace.

", - "TagResource": "

Creates tags for the specified resource.

", - "UntagResource": "

Deletes tags from the specified resource.

", - "UpdateLoggingConfiguration": "

Update logging configuration.

", - "UpdateWorkspaceAlias": "

Updates an AMP workspace alias.

" + "CreateAlertManagerDefinition": "

The CreateAlertManagerDefinition operation creates the alert manager definition in a workspace. If a workspace already has an alert manager definition, don't use this operation to update it. Instead, use PutAlertManagerDefinition.

", + "CreateLoggingConfiguration": "

The CreateLoggingConfiguration operation creates a logging configuration for the workspace. Use this operation to set the CloudWatch log group to which the logs will be published to.

", + "CreateRuleGroupsNamespace": "

The CreateRuleGroupsNamespace operation creates a rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to create new rule groups namespaces. To update an existing rule groups namespace, use PutRuleGroupsNamespace.

", + "CreateScraper": "

The CreateScraper operation creates a scraper to collect metrics. A scraper pulls metrics from Prometheus-compatible sources within an Amazon EKS cluster, and sends them to your Amazon Managed Service for Prometheus workspace. You can configure the scraper to control what metrics are collected, and what transformations are applied prior to sending them to your workspace.

If needed, an IAM role will be created for you that gives Amazon Managed Service for Prometheus access to the metrics in your cluster. For more information, see Using roles for scraping metrics from EKS in the Amazon Managed Service for Prometheus User Guide.

You cannot update a scraper. If you want to change the configuration of the scraper, create a new scraper and delete the old one.

The scrapeConfiguration parameter contains the base64-encoded version of the YAML configuration file.

For more information about collectors, including what metrics are collected, and how to configure the scraper, see Amazon Web Services managed collectors in the Amazon Managed Service for Prometheus User Guide.

", + "CreateWorkspace": "

Creates a Prometheus workspace. A workspace is a logical space dedicated to the storage and querying of Prometheus metrics. You can have one or more workspaces in each Region in your account.

", + "DeleteAlertManagerDefinition": "

Deletes the alert manager definition from a workspace.

", + "DeleteLoggingConfiguration": "

Deletes the logging configuration for a workspace.

", + "DeleteRuleGroupsNamespace": "

Deletes one rule groups namespace and its associated rule groups definition.

", + "DeleteScraper": "

The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.

", + "DeleteWorkspace": "

Deletes an existing workspace.

When you delete a workspace, the data that has been ingested into it is not immediately deleted. It will be permanently deleted within one month.

", + "DescribeAlertManagerDefinition": "

Retrieves the full information about the alert manager definition for a workspace.

", + "DescribeLoggingConfiguration": "

Returns complete information about the current logging configuration of the workspace.

", + "DescribeRuleGroupsNamespace": "

Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.

", + "DescribeScraper": "

The DescribeScraper operation displays information about an existing scraper.

", + "DescribeWorkspace": "

Returns information about an existing workspace.

", + "GetDefaultScraperConfiguration": "

The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.

", + "ListRuleGroupsNamespaces": "

Returns a list of rule groups namespaces in a workspace.

", + "ListScrapers": "

The ListScrapers operation lists all of the scrapers in your account. This includes scrapers being created or deleted. You can optionally filter the returned list.

", + "ListTagsForResource": "

The ListTagsForResource operation returns the tags that are associated with an Amazon Managed Service for Prometheus resource. Currently, the only resources that can be tagged are workspaces and rule groups namespaces.

", + "ListWorkspaces": "

Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.

", + "PutAlertManagerDefinition": "

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

", + "PutRuleGroupsNamespace": "

Updates an existing rule groups namespace within a workspace. A rule groups namespace is associated with exactly one rules file. A workspace can have multiple rule groups namespaces.

Use this operation only to update existing rule groups namespaces. To create a new rule groups namespace, use CreateRuleGroupsNamespace.

You can't use this operation to add tags to an existing rule groups namespace. Instead, use TagResource.

", + "TagResource": "

The TagResource operation associates tags with an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

", + "UntagResource": "

Removes the specified tags from an Amazon Managed Service for Prometheus resource. The only resources that can be tagged are workspaces and rule groups namespaces.

", + "UpdateLoggingConfiguration": "

Updates the log group ARN or the workspace ID of the current logging configuration.

", + "UpdateWorkspaceAlias": "

Updates the alias of an existing workspace.

" }, "shapes": { "AccessDeniedException": { - "base": "

User does not have sufficient access to perform this action.

", + "base": "

You do not have sufficient access to perform this action.

", "refs": { } }, "AlertManagerDefinitionData": { - "base": "

The alert manager definition data.

", + "base": "

The base-64 encoded blob that is alert manager definition.

For details about the alert manager definition, see AlertManagedDefinitionData.

", "refs": { - "AlertManagerDefinitionDescription$data": "

The alert manager definition.

", - "CreateAlertManagerDefinitionRequest$data": "

The alert manager definition data.

", - "PutAlertManagerDefinitionRequest$data": "

The alert manager definition data.

" + "AlertManagerDefinitionDescription$data": "

The actual alert manager definition.

For details about the alert manager definition, see AlertManagedDefinitionData.

", + "CreateAlertManagerDefinitionRequest$data": "

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

For details about the alert manager definition, see AlertManagedDefinitionData.

", + "PutAlertManagerDefinitionRequest$data": "

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

For details about the alert manager definition, see AlertManagedDefinitionData.

" } }, "AlertManagerDefinitionDescription": { - "base": "

Represents the properties of an alert manager definition.

", + "base": "

The details of an alert manager definition.

", "refs": { - "DescribeAlertManagerDefinitionResponse$alertManagerDefinition": "

The properties of the selected workspace's alert manager definition.

" + "DescribeAlertManagerDefinitionResponse$alertManagerDefinition": "

The alert manager definition.

" } }, "AlertManagerDefinitionStatus": { - "base": "

Represents the status of a definition.

", + "base": "

The status of the alert manager.

", "refs": { - "AlertManagerDefinitionDescription$status": "

The status of alert manager definition.

", - "CreateAlertManagerDefinitionResponse$status": "

The status of alert manager definition.

", - "PutAlertManagerDefinitionResponse$status": "

The status of alert manager definition.

" + "AlertManagerDefinitionDescription$status": "

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

", + "CreateAlertManagerDefinitionResponse$status": "

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

", + "PutAlertManagerDefinitionResponse$status": "

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

" } }, "AlertManagerDefinitionStatusCode": { - "base": "

State of an alert manager definition.

", + "base": "

State of an AlertManagerDefinition.

", "refs": { - "AlertManagerDefinitionStatus$statusCode": "

Status code of this definition.

" + "AlertManagerDefinitionStatus$statusCode": "

The current status of the alert manager.

" } }, "AmpConfiguration": { - "base": "

A representation of an AMP destination.

", + "base": "

The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.

", "refs": { - "Destination$ampConfiguration": "

A representation of an AMP destination.

" + "Destination$ampConfiguration": "

The Amazon Managed Service for Prometheusworkspace to send metrics to.

" } }, "Blob": { "base": null, "refs": { - "GetDefaultScraperConfigurationResponse$configuration": "

The default configuration.

", - "ScrapeConfiguration$configurationBlob": "

Binary data representing a Prometheus configuration file.

" + "GetDefaultScraperConfigurationResponse$configuration": "

The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.

", + "ScrapeConfiguration$configurationBlob": "

The base 64 encoded scrape configuration file.

" } }, "ClusterArn": { "base": "

The ARN of an EKS cluster.

", "refs": { - "EksConfiguration$clusterArn": "

The ARN of an EKS cluster.

" + "EksConfiguration$clusterArn": "

ARN of the Amazon EKS cluster.

" } }, "ConflictException": { - "base": "

Updating or deleting a resource can cause an inconsistent state.

", + "base": "

The request would cause an inconsistent state.

", "refs": { } }, "CreateAlertManagerDefinitionRequest": { - "base": "

Represents the input of a CreateAlertManagerDefinition operation.

", + "base": "

Represents the input of a CreateAlertManagerDefinition operation.

", "refs": { } }, "CreateAlertManagerDefinitionResponse": { - "base": "

Represents the output of a CreateAlertManagerDefinition operation.

", + "base": "

Represents the output of a CreateAlertManagerDefinition operation.

", "refs": { } }, "CreateLoggingConfigurationRequest": { - "base": "

Represents the input of a CreateLoggingConfiguration operation.

", + "base": "

Represents the input of a CreateLoggingConfiguration operation.

", "refs": { } }, "CreateLoggingConfigurationResponse": { - "base": "

Represents the output of a CreateLoggingConfiguration operation.

", + "base": "

Represents the output of a CreateLoggingConfiguration operation.

", "refs": { } }, "CreateRuleGroupsNamespaceRequest": { - "base": "

Represents the input of a CreateRuleGroupsNamespace operation.

", + "base": "

Represents the input of a CreateRuleGroupsNamespace operation.

", "refs": { } }, "CreateRuleGroupsNamespaceResponse": { - "base": "

Represents the output of a CreateRuleGroupsNamespace operation.

", + "base": "

Represents the output of a CreateRuleGroupsNamespace operation.

", "refs": { } }, "CreateScraperRequest": { - "base": "

Represents the input of a CreateScraper operation.

", + "base": "

Represents the input of a CreateScraper operation.

", "refs": { } }, "CreateScraperResponse": { - "base": "

Represents the output of a CreateScraper operation.

", + "base": "

Represents the output of a CreateScraper operation.

", "refs": { } }, "CreateWorkspaceRequest": { - "base": "

Represents the input of a CreateWorkspace operation.

", + "base": "

Represents the input of a CreateWorkspace operation.

", "refs": { } }, "CreateWorkspaceResponse": { - "base": "

Represents the output of a CreateWorkspace operation.

", + "base": "

Represents the output of a CreateWorkspace operation.

", "refs": { } }, "DeleteAlertManagerDefinitionRequest": { - "base": "

Represents the input of a DeleteAlertManagerDefinition operation.

", + "base": "

Represents the input of a DeleteAlertManagerDefinition operation.

", "refs": { } }, "DeleteLoggingConfigurationRequest": { - "base": "

Represents the input of a DeleteLoggingConfiguration operation.

", + "base": "

Represents the input of a DeleteLoggingConfiguration operation.

", "refs": { } }, "DeleteRuleGroupsNamespaceRequest": { - "base": "

Represents the input of a DeleteRuleGroupsNamespace operation.

", + "base": "

Represents the input of a DeleteRuleGroupsNamespace operation.

", "refs": { } }, "DeleteScraperRequest": { - "base": "

Represents the input of a DeleteScraper operation.

", + "base": "

Represents the input of a DeleteScraper operation.

", "refs": { } }, "DeleteScraperResponse": { - "base": "

Represents the output of a DeleteScraper operation.

", + "base": "

Represents the output of a DeleteScraper operation.

", "refs": { } }, "DeleteWorkspaceRequest": { - "base": "

Represents the input of a DeleteWorkspace operation.

", + "base": "

Represents the input of a DeleteWorkspace operation.

", "refs": { } }, "DescribeAlertManagerDefinitionRequest": { - "base": "

Represents the input of a DescribeAlertManagerDefinition operation.

", + "base": "

Represents the input of a DescribeAlertManagerDefinition operation.

", "refs": { } }, "DescribeAlertManagerDefinitionResponse": { - "base": "

Represents the output of a DescribeAlertManagerDefinition operation.

", + "base": "

Represents the output of a DescribeAlertManagerDefinition operation.

", "refs": { } }, "DescribeLoggingConfigurationRequest": { - "base": "

Represents the input of a DescribeLoggingConfiguration operation.

", + "base": "

Represents the input of a DescribeLoggingConfiguration operation.

", "refs": { } }, "DescribeLoggingConfigurationResponse": { - "base": "

Represents the output of a DescribeLoggingConfiguration operation.

", + "base": "

Represents the output of a DescribeLoggingConfiguration operation.

", "refs": { } }, "DescribeRuleGroupsNamespaceRequest": { - "base": "

Represents the input of a DescribeRuleGroupsNamespace operation.

", + "base": "

Represents the input of a DescribeRuleGroupsNamespace operation.

", "refs": { } }, "DescribeRuleGroupsNamespaceResponse": { - "base": "

Represents the output of a DescribeRuleGroupsNamespace operation.

", + "base": "

Represents the output of a DescribeRuleGroupsNamespace operation.

", "refs": { } }, "DescribeScraperRequest": { - "base": "

Represents the input of a DescribeScraper operation.

", + "base": "

Represents the input of a DescribeScraper operation.

", "refs": { } }, "DescribeScraperResponse": { - "base": "

Represents the output of a DescribeScraper operation.

", + "base": "

Represents the output of a DescribeScraper operation.

", "refs": { } }, "DescribeWorkspaceRequest": { - "base": "

Represents the input of a DescribeWorkspace operation.

", + "base": "

Represents the input of a DescribeWorkspace operation.

", "refs": { } }, "DescribeWorkspaceResponse": { - "base": "

Represents the output of a DescribeWorkspace operation.

", + "base": "

Represents the output of a DescribeWorkspace operation.

", "refs": { } }, "Destination": { - "base": "

A representation of a destination that a scraper can produce metrics to.

", + "base": "

Where to send the metrics from a scraper.

", "refs": { - "CreateScraperRequest$destination": "

The destination that the scraper will be producing metrics to.

", - "ScraperDescription$destination": "

The destination that the scraper is producing metrics to.

", - "ScraperSummary$destination": "

The destination that the scraper is producing metrics to.

" + "CreateScraperRequest$destination": "

The Amazon Managed Service for Prometheus workspace to send metrics to.

", + "ScraperDescription$destination": "

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

", + "ScraperSummary$destination": "

The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.

" } }, "EksConfiguration": { - "base": "

A representation of an EKS source.

", + "base": "

The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.

", "refs": { - "Source$eksConfiguration": "

A representation of an EKS source.

" + "Source$eksConfiguration": "

The Amazon EKS cluster from which a scraper collects metrics.

" } }, "FilterKey": { - "base": "

The name of the key to filter by.

", + "base": "

The name of the key by which to filter.

", "refs": { - "ScraperFilters$key": "

The name of the key to filter by. Currently supported filter keys are 'status', 'sourceArn', 'destinationArn', and 'alias'.

" + "ScraperFilters$key": "

The name of the key to filter by. Currently supported filter keys are status, sourceArn, destinationArn, and alias.

" } }, "FilterValue": { - "base": "

The value of a given key to filter by.

", + "base": "

The value for a given key by which to filter.

", "refs": { "FilterValues$member": null } @@ -246,43 +246,43 @@ "FilterValues": { "base": "

A list of scraper filter values.

", "refs": { - "ScraperFilters$value": "

The values of the given key to filter by.

" + "ScraperFilters$value": "

The values of the given key by which to filter.

" } }, "GetDefaultScraperConfigurationRequest": { - "base": "

Represents the input of a GetDefaultScraperConfiguration operation.

", + "base": "

Represents the input of a GetDefaultScraperConfiguration operation.

", "refs": { } }, "GetDefaultScraperConfigurationResponse": { - "base": "

Represents the output of a GetDefaultScraperConfiguration operation.

", + "base": "

Represents the output of a GetDefaultScraperConfiguration operation.

", "refs": { } }, "IamRoleArn": { "base": "

An ARN identifying an IAM role used by the scraper.

", "refs": { - "ScraperDescription$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.

", - "ScraperSummary$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.

" + "ScraperDescription$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

", + "ScraperSummary$roleArn": "

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.

" } }, "IdempotencyToken": { "base": "

An identifier used to ensure the idempotency of a write request.

", "refs": { - "CreateAlertManagerDefinitionRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "CreateLoggingConfigurationRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "CreateRuleGroupsNamespaceRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "CreateScraperRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "CreateWorkspaceRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "DeleteAlertManagerDefinitionRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "DeleteLoggingConfigurationRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "DeleteRuleGroupsNamespaceRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "DeleteScraperRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "DeleteWorkspaceRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "PutAlertManagerDefinitionRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "PutRuleGroupsNamespaceRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "UpdateLoggingConfigurationRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

", - "UpdateWorkspaceAliasRequest$clientToken": "

Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.

" + "CreateAlertManagerDefinitionRequest$clientToken": "

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

", + "CreateLoggingConfigurationRequest$clientToken": "

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

", + "CreateRuleGroupsNamespaceRequest$clientToken": "

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

", + "CreateScraperRequest$clientToken": "

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

", + "CreateWorkspaceRequest$clientToken": "

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

", + "DeleteAlertManagerDefinitionRequest$clientToken": "

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

", + "DeleteLoggingConfigurationRequest$clientToken": "

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

", + "DeleteRuleGroupsNamespaceRequest$clientToken": "

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

", + "DeleteScraperRequest$clientToken": "

(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.

", + "DeleteWorkspaceRequest$clientToken": "

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

", + "PutAlertManagerDefinitionRequest$clientToken": "

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

", + "PutRuleGroupsNamespaceRequest$clientToken": "

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

", + "UpdateLoggingConfigurationRequest$clientToken": "

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

", + "UpdateWorkspaceAliasRequest$clientToken": "

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

" } }, "Integer": { @@ -293,48 +293,48 @@ } }, "InternalServerException": { - "base": "

Unexpected error during processing of request.

", + "base": "

An unexpected error occurred during the processing of the request.

", "refs": { } }, "KmsKeyArn": { "base": "

A KMS Key ARN.

", "refs": { - "CreateWorkspaceRequest$kmsKeyArn": "

Optional, customer managed KMS key used to encrypt data for this workspace

", - "CreateWorkspaceResponse$kmsKeyArn": "

Customer managed KMS key ARN for this workspace

", - "WorkspaceDescription$kmsKeyArn": "

The customer managed KMS key of this workspace.

", - "WorkspaceSummary$kmsKeyArn": "

Customer managed KMS key ARN for this workspace

" + "CreateWorkspaceRequest$kmsKeyArn": "

(optional) The ARN for a customer managed KMS key to use for encrypting data within your workspace. For more information about using your own key in your workspace, see Encryption at rest in the Amazon Managed Service for Prometheus User Guide.

", + "CreateWorkspaceResponse$kmsKeyArn": "

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

", + "WorkspaceDescription$kmsKeyArn": "

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

", + "WorkspaceSummary$kmsKeyArn": "

(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.

" } }, "ListRuleGroupsNamespacesRequest": { - "base": "

Represents the input of a ListRuleGroupsNamespaces operation.

", + "base": "

Represents the input of a ListRuleGroupsNamespaces operation.

", "refs": { } }, "ListRuleGroupsNamespacesRequestMaxResultsInteger": { "base": null, "refs": { - "ListRuleGroupsNamespacesRequest$maxResults": "

Maximum results to return in response (default=100, maximum=1000).

" + "ListRuleGroupsNamespacesRequest$maxResults": "

The maximum number of results to return. The default is 100.

" } }, "ListRuleGroupsNamespacesResponse": { - "base": "

Represents the output of a ListRuleGroupsNamespaces operation.

", + "base": "

Represents the output of a ListRuleGroupsNamespaces operation.

", "refs": { } }, "ListScrapersRequest": { - "base": "

Represents the input of a ListScrapers operation.

", + "base": "

Represents the input of a ListScrapers operation.

", "refs": { } }, "ListScrapersRequestMaxResultsInteger": { "base": null, "refs": { - "ListScrapersRequest$maxResults": "

Maximum results to return in response (default=100, maximum=1000).

" + "ListScrapersRequest$maxResults": "

Optional) The maximum number of scrapers to return in one ListScrapers operation. The range is 1-1000.

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

" } }, "ListScrapersResponse": { - "base": "

Represents the output of a ListScrapers operation.

", + "base": "

Represents the output of a ListScrapers operation.

", "refs": { } }, @@ -349,139 +349,139 @@ } }, "ListWorkspacesRequest": { - "base": "

Represents the input of a ListWorkspaces operation.

", + "base": "

Represents the input of a ListWorkspaces operation.

", "refs": { } }, "ListWorkspacesRequestMaxResultsInteger": { "base": null, "refs": { - "ListWorkspacesRequest$maxResults": "

Maximum results to return in response (default=100, maximum=1000).

" + "ListWorkspacesRequest$maxResults": "

The maximum number of workspaces to return per request. The default is 100.

" } }, "ListWorkspacesResponse": { - "base": "

Represents the output of a ListWorkspaces operation.

", + "base": "

Represents the output of a ListWorkspaces operation.

", "refs": { } }, "LogGroupArn": { "base": null, "refs": { - "CreateLoggingConfigurationRequest$logGroupArn": "

The ARN of the CW log group to which the vended log data will be published.

", - "LoggingConfigurationMetadata$logGroupArn": "

The ARN of the CW log group to which the vended log data will be published.

", - "UpdateLoggingConfigurationRequest$logGroupArn": "

The ARN of the CW log group to which the vended log data will be published.

" + "CreateLoggingConfigurationRequest$logGroupArn": "

The ARN of the CloudWatch log group to which the vended log data will be published. This log group must exist prior to calling this API.

", + "LoggingConfigurationMetadata$logGroupArn": "

The ARN of the CloudWatch log group to which the vended log data will be published.

", + "UpdateLoggingConfigurationRequest$logGroupArn": "

The ARN of the CloudWatch log group to which the vended log data will be published.

" } }, "LoggingConfigurationMetadata": { - "base": "

Represents the properties of a logging configuration metadata.

", + "base": "

Contains information about the logging configuration.

", "refs": { - "DescribeLoggingConfigurationResponse$loggingConfiguration": "

Metadata object containing information about the logging configuration of a workspace.

" + "DescribeLoggingConfigurationResponse$loggingConfiguration": "

A structure that displays the information about the logging configuration.

" } }, "LoggingConfigurationStatus": { - "base": "

Represents the status of a logging configuration.

", + "base": "

The status of the logging configuration.

", "refs": { - "CreateLoggingConfigurationResponse$status": "

The status of the logging configuration.

", - "LoggingConfigurationMetadata$status": "

The status of the logging configuration.

", - "UpdateLoggingConfigurationResponse$status": "

The status of the logging configuration.

" + "CreateLoggingConfigurationResponse$status": "

A structure that displays the current status of the logging configuration.

", + "LoggingConfigurationMetadata$status": "

The current status of the logging configuration.

", + "UpdateLoggingConfigurationResponse$status": "

A structure that contains the current status of the logging configuration.

" } }, "LoggingConfigurationStatusCode": { "base": "

State of a logging configuration.

", "refs": { - "LoggingConfigurationStatus$statusCode": "

Status code of the logging configuration.

" + "LoggingConfigurationStatus$statusCode": "

The current status of the logging configuration.

" } }, "PaginationToken": { "base": "

A token used to access the next page in a paginated result set.

", "refs": { - "ListRuleGroupsNamespacesRequest$nextToken": "

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.

", - "ListRuleGroupsNamespacesResponse$nextToken": "

Pagination token to use when requesting the next page in this list.

", - "ListScrapersRequest$nextToken": "

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.

", - "ListScrapersResponse$nextToken": "

Pagination token to use when requesting the next page in this list.

", - "ListWorkspacesRequest$nextToken": "

Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.

", - "ListWorkspacesResponse$nextToken": "

Pagination token to use when requesting the next page in this list.

" + "ListRuleGroupsNamespacesRequest$nextToken": "

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 rule groups namespaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 namespaces.

", + "ListRuleGroupsNamespacesResponse$nextToken": "

A token indicating that there are more results to retrieve. You can use this token as part of your next ListRuleGroupsNamespaces request to retrieve those results.

", + "ListScrapersRequest$nextToken": "

(Optional) The token for the next set of items to return. (You received this token from a previous call.)

", + "ListScrapersResponse$nextToken": "

A token indicating that there are more results to retrieve. You can use this token as part of your next ListScrapers operation to retrieve those results.

", + "ListWorkspacesRequest$nextToken": "

The token for the next set of items to return. You receive this token from a previous call, and use it to get the next page of results. The other parameters must be the same as the initial call.

For example, if your initial request has maxResults of 10, and there are 12 workspaces to return, then your initial request will return 10 and a nextToken. Using the next token in a subsequent call will return the remaining 2 workspaces.

", + "ListWorkspacesResponse$nextToken": "

A token indicating that there are more results to retrieve. You can use this token as part of your next ListWorkspaces request to retrieve those results.

" } }, "PutAlertManagerDefinitionRequest": { - "base": "

Represents the input of a PutAlertManagerDefinition operation.

", + "base": "

Represents the input of a PutAlertManagerDefinition operation.

", "refs": { } }, "PutAlertManagerDefinitionResponse": { - "base": "

Represents the output of a PutAlertManagerDefinition operation.

", + "base": "

Represents the output of a PutAlertManagerDefinition operation.

", "refs": { } }, "PutRuleGroupsNamespaceRequest": { - "base": "

Represents the input of a PutRuleGroupsNamespace operation.

", + "base": "

Represents the input of a PutRuleGroupsNamespace operation.

", "refs": { } }, "PutRuleGroupsNamespaceResponse": { - "base": "

Represents the output of a PutRuleGroupsNamespace operation.

", + "base": "

Represents the output of a PutRuleGroupsNamespace operation.

", "refs": { } }, "ResourceNotFoundException": { - "base": "

Request references a resource which does not exist.

", + "base": "

The request references a resources that doesn't exist.

", "refs": { } }, "RuleGroupsNamespaceArn": { "base": "

An ARN identifying a rule groups namespace.

", "refs": { - "CreateRuleGroupsNamespaceResponse$arn": "

The Amazon Resource Name (ARN) of this rule groups namespace.

", - "PutRuleGroupsNamespaceResponse$arn": "

The Amazon Resource Name (ARN) of this rule groups namespace.

", - "RuleGroupsNamespaceDescription$arn": "

The Amazon Resource Name (ARN) of this rule groups namespace.

", - "RuleGroupsNamespaceSummary$arn": "

The Amazon Resource Name (ARN) of this rule groups namespace.

" + "CreateRuleGroupsNamespaceResponse$arn": "

The Amazon Resource Name (ARN) of the new rule groups namespace.

", + "PutRuleGroupsNamespaceResponse$arn": "

The ARN of the rule groups namespace.

", + "RuleGroupsNamespaceDescription$arn": "

The ARN of the rule groups namespace.

", + "RuleGroupsNamespaceSummary$arn": "

The ARN of the rule groups namespace.

" } }, "RuleGroupsNamespaceData": { "base": "

The rule groups namespace data.

", "refs": { - "CreateRuleGroupsNamespaceRequest$data": "

The namespace data that define the rule groups.

", - "PutRuleGroupsNamespaceRequest$data": "

The namespace data that define the rule groups.

", - "RuleGroupsNamespaceDescription$data": "

The rule groups namespace data.

" + "CreateRuleGroupsNamespaceRequest$data": "

The rules file to use in the new namespace.

Contains the base64-encoded version of the YAML rules file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

", + "PutRuleGroupsNamespaceRequest$data": "

The new rules file to use in the namespace. A base64-encoded version of the YAML rule groups file.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

", + "RuleGroupsNamespaceDescription$data": "

The rule groups file used in the namespace.

For details about the rule groups namespace structure, see RuleGroupsNamespaceData.

" } }, "RuleGroupsNamespaceDescription": { - "base": "

Represents a description of the rule groups namespace.

", + "base": "

The details about one rule groups namespace.

", "refs": { - "DescribeRuleGroupsNamespaceResponse$ruleGroupsNamespace": "

The selected rule groups namespace.

" + "DescribeRuleGroupsNamespaceResponse$ruleGroupsNamespace": "

The information about the rule groups namespace.

" } }, "RuleGroupsNamespaceName": { - "base": "

The namespace name that the rule group belong to.

", + "base": "

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

", "refs": { - "CreateRuleGroupsNamespaceRequest$name": "

The rule groups namespace name.

", - "CreateRuleGroupsNamespaceResponse$name": "

The rule groups namespace name.

", - "DeleteRuleGroupsNamespaceRequest$name": "

The rule groups namespace name.

", - "DescribeRuleGroupsNamespaceRequest$name": "

The rule groups namespace.

", - "ListRuleGroupsNamespacesRequest$name": "

Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.

", - "PutRuleGroupsNamespaceRequest$name": "

The rule groups namespace name.

", - "PutRuleGroupsNamespaceResponse$name": "

The rule groups namespace name.

", - "RuleGroupsNamespaceDescription$name": "

The rule groups namespace name.

", - "RuleGroupsNamespaceSummary$name": "

The rule groups namespace name.

" + "CreateRuleGroupsNamespaceRequest$name": "

The name for the new rule groups namespace.

", + "CreateRuleGroupsNamespaceResponse$name": "

The name of the new rule groups namespace.

", + "DeleteRuleGroupsNamespaceRequest$name": "

The name of the rule groups namespace to delete.

", + "DescribeRuleGroupsNamespaceRequest$name": "

The name of the rule groups namespace that you want information for.

", + "ListRuleGroupsNamespacesRequest$name": "

Use this parameter to filter the rule groups namespaces that are returned. Only the namespaces with names that begin with the value that you specify are returned.

", + "PutRuleGroupsNamespaceRequest$name": "

The name of the rule groups namespace that you are updating.

", + "PutRuleGroupsNamespaceResponse$name": "

The name of the rule groups namespace that was updated.

", + "RuleGroupsNamespaceDescription$name": "

The name of the rule groups namespace.

", + "RuleGroupsNamespaceSummary$name": "

The name of the rule groups namespace.

" } }, "RuleGroupsNamespaceStatus": { - "base": "

Represents the status of a namespace.

", + "base": "

The status information about a rule groups namespace.

", "refs": { - "CreateRuleGroupsNamespaceResponse$status": "

The status of rule groups namespace.

", - "PutRuleGroupsNamespaceResponse$status": "

The status of rule groups namespace.

", - "RuleGroupsNamespaceDescription$status": "

The status of rule groups namespace.

", - "RuleGroupsNamespaceSummary$status": "

The status of rule groups namespace.

" + "CreateRuleGroupsNamespaceResponse$status": "

A structure that returns the current status of the rule groups namespace.

", + "PutRuleGroupsNamespaceResponse$status": "

A structure that includes the current status of the rule groups namespace.

", + "RuleGroupsNamespaceDescription$status": "

The current status of the rule groups namespace.

", + "RuleGroupsNamespaceSummary$status": "

A structure that displays the current status of the rule groups namespace.

" } }, "RuleGroupsNamespaceStatusCode": { "base": "

State of a namespace.

", "refs": { - "RuleGroupsNamespaceStatus$statusCode": "

Status code of this namespace.

" + "RuleGroupsNamespaceStatus$statusCode": "

The current status of the namespace.

" } }, "RuleGroupsNamespaceSummary": { - "base": "

Represents a summary of the rule groups namespace.

", + "base": "

The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.

", "refs": { "RuleGroupsNamespaceSummaryList$member": null } @@ -489,72 +489,72 @@ "RuleGroupsNamespaceSummaryList": { "base": "

A list of rule groups namespace summary.

", "refs": { - "ListRuleGroupsNamespacesResponse$ruleGroupsNamespaces": "

The list of the selected rule groups namespaces.

" + "ListRuleGroupsNamespacesResponse$ruleGroupsNamespaces": "

The returned list of rule groups namespaces.

" } }, "ScrapeConfiguration": { - "base": "

A representation of a Prometheus configuration file.

", + "base": "

A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

", "refs": { - "CreateScraperRequest$scrapeConfiguration": "

The configuration used to create the scraper.

", - "ScraperDescription$scrapeConfiguration": "

The configuration used to create the scraper.

" + "CreateScraperRequest$scrapeConfiguration": "

The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.

", + "ScraperDescription$scrapeConfiguration": "

The configuration file in use by the scraper.

" } }, "ScraperAlias": { "base": "

A user-assigned scraper alias.

", "refs": { - "CreateScraperRequest$alias": "

An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.

", - "ScraperDescription$alias": "

Alias of this scraper.

", - "ScraperSummary$alias": "

Alias of this scraper.

" + "CreateScraperRequest$alias": "

(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.

", + "ScraperDescription$alias": "

(Optional) A name associated with the scraper.

", + "ScraperSummary$alias": "

(Optional) A name associated with the scraper.

" } }, "ScraperArn": { "base": "

An ARN identifying a scrape configuration.

", "refs": { - "CreateScraperResponse$arn": "

The ARN of the scraper that was just created.

", - "ScraperDescription$arn": "

The Amazon Resource Name (ARN) of this scraper.

", - "ScraperSummary$arn": "

The Amazon Resource Name (ARN) of this scraper.

" + "CreateScraperResponse$arn": "

The Amazon Resource Name (ARN) of the new scraper.

", + "ScraperDescription$arn": "

The Amazon Resource Name (ARN) of the scraper.

", + "ScraperSummary$arn": "

The Amazon Resource Name (ARN) of the scraper.

" } }, "ScraperDescription": { - "base": "

Represents the properties of a scraper.

", + "base": "

The ScraperDescription structure contains the full details about one scraper in your account.

", "refs": { - "DescribeScraperResponse$scraper": "

The properties of the selected scrapers.

" + "DescribeScraperResponse$scraper": "

Contains details about the scraper.

" } }, "ScraperFilters": { "base": "

A list of scraper filters.

", "refs": { - "ListScrapersRequest$filters": "

A list of scraper filters.

" + "ListScrapersRequest$filters": "

(Optional) A list of key-value pairs to filter the list of scrapers returned. Keys include status, sourceArn, destinationArn, and alias.

Filters on the same key are OR'd together, and filters on different keys are AND'd together. For example, status=ACTIVE&status=CREATING&alias=Test, will return all scrapers that have the alias Test, and are either in status ACTIVE or CREATING.

To find all active scrapers that are sending metrics to a specific Amazon Managed Service for Prometheus workspace, you would use the ARN of the workspace in a query:

status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012

If this is included, it filters the results to only the scrapers that match the filter.

" } }, "ScraperId": { "base": "

A scraper ID.

", "refs": { - "CreateScraperResponse$scraperId": "

The generated ID of the scraper that was just created.

", + "CreateScraperResponse$scraperId": "

The ID of the new scraper.

", "DeleteScraperRequest$scraperId": "

The ID of the scraper to delete.

", - "DeleteScraperResponse$scraperId": "

The ID of the scraper that was deleted.

", - "DescribeScraperRequest$scraperId": "

The IDs of the scraper to describe.

", - "ScraperDescription$scraperId": "

Unique string identifying this scraper.

", - "ScraperSummary$scraperId": "

Unique string identifying this scraper.

" + "DeleteScraperResponse$scraperId": "

The ID of the scraper to delete.

", + "DescribeScraperRequest$scraperId": "

The ID of the scraper to describe.

", + "ScraperDescription$scraperId": "

The ID of the scraper.

", + "ScraperSummary$scraperId": "

The ID of the scraper.

" } }, "ScraperStatus": { - "base": "

Represents the status of a scraper.

", + "base": "

The ScraperStatus structure contains status information about the scraper.

", "refs": { - "CreateScraperResponse$status": "

The status of the scraper that was just created (usually CREATING).

", - "DeleteScraperResponse$status": "

The status of the scraper that is being deleted.

", - "ScraperDescription$status": "

The status of this scraper.

", - "ScraperSummary$status": "

The status of this scraper.

" + "CreateScraperResponse$status": "

A structure that displays the current status of the scraper.

", + "DeleteScraperResponse$status": "

The current status of the scraper.

", + "ScraperDescription$status": "

A structure that contains the current status of the scraper.

", + "ScraperSummary$status": "

A structure that contains the current status of the scraper.

" } }, "ScraperStatusCode": { "base": "

State of a scraper.

", "refs": { - "ScraperStatus$statusCode": "

Status code of this scraper.

" + "ScraperStatus$statusCode": "

The current status of the scraper.

" } }, "ScraperSummary": { - "base": "

Represents a summary of the properties of a scraper.

", + "base": "

The ScraperSummary structure contains a summary of the details about one scraper in your account.

", "refs": { "ScraperSummaryList$member": null } @@ -562,7 +562,7 @@ "ScraperSummaryList": { "base": "

A list of scraper summaries.

", "refs": { - "ListScrapersResponse$scrapers": "

The list of scrapers, filtered down if a set of filters was provided in the request.

" + "ListScrapersResponse$scrapers": "

A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.

" } }, "SecurityGroupId": { @@ -574,57 +574,57 @@ "SecurityGroupIds": { "base": "

A list of security group IDs specified for VPC configuration.

", "refs": { - "EksConfiguration$securityGroupIds": "

A list of security group IDs specified for VPC configuration.

" + "EksConfiguration$securityGroupIds": "

A list of the security group IDs for the Amazon EKS cluster VPC configuration.

" } }, "ServiceQuotaExceededException": { - "base": "

Request would cause a service quota to be exceeded.

", + "base": "

Completing the request would cause a service quota to be exceeded.

", "refs": { } }, "Source": { - "base": "

A representation of a source that a scraper can discover and collect metrics from.

", + "base": "

The source of collected metrics for a scraper.

", "refs": { - "CreateScraperRequest$source": "

The source that the scraper will be discovering and collecting metrics from.

", - "ScraperDescription$source": "

The source that the scraper is discovering and collecting metrics from.

", - "ScraperSummary$source": "

The source that the scraper is discovering and collecting metrics from.

" + "CreateScraperRequest$source": "

The Amazon EKS cluster from which the scraper will collect metrics.

", + "ScraperDescription$source": "

The Amazon EKS cluster from which the scraper collects metrics.

", + "ScraperSummary$source": "

The Amazon EKS cluster from which the scraper collects metrics.

" } }, "StatusReason": { - "base": "

The reason for failure if any.

", + "base": "

The reason for the failure, if any.

", "refs": { - "ScraperDescription$statusReason": "

The reason for failure if any.

", - "ScraperSummary$statusReason": "

The reason for failure if any.

" + "ScraperDescription$statusReason": "

If there is a failure, the reason for the failure.

", + "ScraperSummary$statusReason": "

If there is a failure, the reason for the failure.

" } }, "String": { "base": null, "refs": { "AccessDeniedException$message": "

Description of the error.

", - "AlertManagerDefinitionStatus$statusReason": "

The reason for failure if any.

", + "AlertManagerDefinitionStatus$statusReason": "

If there is a failure, the reason for the failure.

", "ConflictException$message": "

Description of the error.

", "ConflictException$resourceId": "

Identifier of the resource affected.

", "ConflictException$resourceType": "

Type of the resource affected.

", "InternalServerException$message": "

Description of the error.

", - "ListTagsForResourceRequest$resourceArn": "

The ARN of the resource.

", - "LoggingConfigurationStatus$statusReason": "

The reason for failure if any.

", + "ListTagsForResourceRequest$resourceArn": "

The ARN of the resource to list tages for. Must be a workspace or rule groups namespace resource.

", + "LoggingConfigurationStatus$statusReason": "

If failed, the reason for the failure.

", "ResourceNotFoundException$message": "

Description of the error.

", "ResourceNotFoundException$resourceId": "

Identifier of the resource affected.

", "ResourceNotFoundException$resourceType": "

Type of the resource affected.

", - "RuleGroupsNamespaceStatus$statusReason": "

The reason for failure if any.

", + "RuleGroupsNamespaceStatus$statusReason": "

The reason for the failure, if any.

", "ServiceQuotaExceededException$message": "

Description of the error.

", + "ServiceQuotaExceededException$quotaCode": "

Service quotas code of the originating quota.

", "ServiceQuotaExceededException$resourceId": "

Identifier of the resource affected.

", "ServiceQuotaExceededException$resourceType": "

Type of the resource affected.

", - "ServiceQuotaExceededException$serviceCode": "

Service Quotas requirement to identify originating service.

", - "ServiceQuotaExceededException$quotaCode": "

Service Quotas requirement to identify originating quota.

", - "TagResourceRequest$resourceArn": "

The ARN of the resource.

", + "ServiceQuotaExceededException$serviceCode": "

Service quotas code for the originating service.

", + "TagResourceRequest$resourceArn": "

The ARN of the workspace or rule groups namespace to apply tags to.

", "ThrottlingException$message": "

Description of the error.

", - "ThrottlingException$serviceCode": "

Service Quotas requirement to identify originating service.

", - "ThrottlingException$quotaCode": "

Service Quotas requirement to identify originating quota.

", - "UntagResourceRequest$resourceArn": "

The ARN of the resource.

", + "ThrottlingException$quotaCode": "

Service quotas code for the originating quota.

", + "ThrottlingException$serviceCode": "

Service quotas code for the originating service.

", + "UntagResourceRequest$resourceArn": "

The ARN of the workspace or rule groups namespace.

", "ValidationException$message": "

Description of the error.

", - "ValidationExceptionField$name": "

The field name.

", - "ValidationExceptionField$message": "

Message describing why the field failed validation.

" + "ValidationExceptionField$message": "

A message describing why the field caused an exception.

", + "ValidationExceptionField$name": "

The name of the field that caused an exception.

" } }, "SubnetId": { @@ -636,40 +636,40 @@ "SubnetIds": { "base": "

A list of subnet IDs specified for VPC configuration.

", "refs": { - "EksConfiguration$subnetIds": "

A list of subnet IDs specified for VPC configuration.

" + "EksConfiguration$subnetIds": "

A list of subnet IDs for the Amazon EKS cluster VPC configuration.

" } }, "TagKey": { "base": null, "refs": { "TagKeys$member": null, - "TagMap$key": "

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 128 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @ May not begin with aws:.

" + "TagMap$key": "

The key of the tag. May not begin with aws:.

" } }, "TagKeys": { "base": null, "refs": { - "UntagResourceRequest$tagKeys": "

One or more tag keys

" + "UntagResourceRequest$tagKeys": "

The keys of the tags to remove.

" } }, "TagMap": { "base": "

The list of tags assigned to the resource.

", "refs": { - "CreateRuleGroupsNamespaceRequest$tags": "

Optional, user-provided tags for this rule groups namespace.

", - "CreateRuleGroupsNamespaceResponse$tags": "

The tags of this rule groups namespace.

", - "CreateScraperRequest$tags": "

Optional, user-provided tags for this scraper.

", - "CreateScraperResponse$tags": "

The tags of this scraper.

", - "CreateWorkspaceRequest$tags": "

Optional, user-provided tags for this workspace.

", - "CreateWorkspaceResponse$tags": "

The tags of this workspace.

", - "ListTagsForResourceResponse$tags": null, - "PutRuleGroupsNamespaceResponse$tags": "

The tags of this rule groups namespace.

", - "RuleGroupsNamespaceDescription$tags": "

The tags of this rule groups namespace.

", - "RuleGroupsNamespaceSummary$tags": "

The tags of this rule groups namespace.

", - "ScraperDescription$tags": "

The tags of this scraper.

", - "ScraperSummary$tags": "

The tags of this scraper.

", - "TagResourceRequest$tags": null, - "WorkspaceDescription$tags": "

The tags of this workspace.

", - "WorkspaceSummary$tags": "

The tags of this workspace.

" + "CreateRuleGroupsNamespaceRequest$tags": "

The list of tag keys and values to associate with the rule groups namespace.

", + "CreateRuleGroupsNamespaceResponse$tags": "

The list of tag keys and values that are associated with the namespace.

", + "CreateScraperRequest$tags": "

(Optional) The list of tag keys and values to associate with the scraper.

", + "CreateScraperResponse$tags": "

The list of tag keys and values that are associated with the scraper.

", + "CreateWorkspaceRequest$tags": "

The list of tag keys and values to associate with the workspace.

", + "CreateWorkspaceResponse$tags": "

The list of tag keys and values that are associated with the workspace.

", + "ListTagsForResourceResponse$tags": "

The list of tag keys and values associated with the resource.

", + "PutRuleGroupsNamespaceResponse$tags": "

The list of tag keys and values that are associated with the namespace.

", + "RuleGroupsNamespaceDescription$tags": "

The list of tag keys and values that are associated with the rule groups namespace.

", + "RuleGroupsNamespaceSummary$tags": "

The list of tag keys and values that are associated with the rule groups namespace.

", + "ScraperDescription$tags": "

(Optional) The list of tag keys and values associated with the scraper.

", + "ScraperSummary$tags": "

(Optional) The list of tag keys and values associated with the scraper.

", + "TagResourceRequest$tags": "

The list of tag keys and values to associate with the resource.

Keys may not begin with aws:.

", + "WorkspaceDescription$tags": "

The list of tag keys and values that are associated with the workspace.

", + "WorkspaceSummary$tags": "

The list of tag keys and values that are associated with the workspace.

" } }, "TagResourceRequest": { @@ -685,31 +685,31 @@ "TagValue": { "base": null, "refs": { - "TagMap$value": "

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters. Valid characters are Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @

" + "TagMap$value": "

The value of the tag.

" } }, "ThrottlingException": { - "base": "

Request was denied due to request throttling.

", + "base": "

The request was denied due to request throttling.

", "refs": { } }, "Timestamp": { "base": null, "refs": { - "AlertManagerDefinitionDescription$createdAt": "

The time when the alert manager definition was created.

", - "AlertManagerDefinitionDescription$modifiedAt": "

The time when the alert manager definition was modified.

", - "LoggingConfigurationMetadata$createdAt": "

The time when the logging configuration was created.

", - "LoggingConfigurationMetadata$modifiedAt": "

The time when the logging configuration was modified.

", - "RuleGroupsNamespaceDescription$createdAt": "

The time when the rule groups namespace was created.

", - "RuleGroupsNamespaceDescription$modifiedAt": "

The time when the rule groups namespace was modified.

", - "RuleGroupsNamespaceSummary$createdAt": "

The time when the rule groups namespace was created.

", - "RuleGroupsNamespaceSummary$modifiedAt": "

The time when the rule groups namespace was modified.

", - "ScraperDescription$createdAt": "

The time when the scraper was created.

", - "ScraperDescription$lastModifiedAt": "

The time when the scraper was last modified.

", - "ScraperSummary$createdAt": "

The time when the scraper was created.

", - "ScraperSummary$lastModifiedAt": "

The time when the scraper was last modified.

", - "WorkspaceDescription$createdAt": "

The time when the workspace was created.

", - "WorkspaceSummary$createdAt": "

The time when the workspace was created.

" + "AlertManagerDefinitionDescription$createdAt": "

The date and time that the alert manager definition was created.

", + "AlertManagerDefinitionDescription$modifiedAt": "

The date and time that the alert manager definition was most recently changed.

", + "LoggingConfigurationMetadata$createdAt": "

The date and time that the logging configuration was created.

", + "LoggingConfigurationMetadata$modifiedAt": "

The date and time that the logging configuration was most recently changed.

", + "RuleGroupsNamespaceDescription$createdAt": "

The date and time that the rule groups namespace was created.

", + "RuleGroupsNamespaceDescription$modifiedAt": "

The date and time that the rule groups namespace was most recently changed.

", + "RuleGroupsNamespaceSummary$createdAt": "

The date and time that the rule groups namespace was created.

", + "RuleGroupsNamespaceSummary$modifiedAt": "

The date and time that the rule groups namespace was most recently changed.

", + "ScraperDescription$createdAt": "

The date and time that the scraper was created.

", + "ScraperDescription$lastModifiedAt": "

The date and time that the scraper was last modified.

", + "ScraperSummary$createdAt": "

The date and time that the scraper was created.

", + "ScraperSummary$lastModifiedAt": "

The date and time that the scraper was last modified.

", + "WorkspaceDescription$createdAt": "

The date and time that the workspace was created.

", + "WorkspaceSummary$createdAt": "

The date and time that the workspace was created.

" } }, "UntagResourceRequest": { @@ -723,33 +723,33 @@ } }, "UpdateLoggingConfigurationRequest": { - "base": "

Represents the input of an UpdateLoggingConfiguration operation.

", + "base": "

Represents the input of an UpdateLoggingConfiguration operation.

", "refs": { } }, "UpdateLoggingConfigurationResponse": { - "base": "

Represents the output of an UpdateLoggingConfiguration operation.

", + "base": "

Represents the output of an UpdateLoggingConfiguration operation.

", "refs": { } }, "UpdateWorkspaceAliasRequest": { - "base": "

Represents the input of an UpdateWorkspaceAlias operation.

", + "base": "

Represents the input of an UpdateWorkspaceAlias operation.

", "refs": { } }, "Uri": { "base": null, "refs": { - "WorkspaceDescription$prometheusEndpoint": "

Prometheus endpoint URI.

" + "WorkspaceDescription$prometheusEndpoint": "

The Prometheus endpoint available for this workspace.

" } }, "ValidationException": { - "base": "

The input fails to satisfy the constraints specified by an AWS service.

", + "base": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", "refs": { } }, "ValidationExceptionField": { - "base": "

Stores information about a field passed inside a request that resulted in an exception.

", + "base": "

Information about a field passed into a request that resulted in an exception.

", "refs": { "ValidationExceptionFieldList$member": null } @@ -757,7 +757,7 @@ "ValidationExceptionFieldList": { "base": "

A list of fields.

", "refs": { - "ValidationException$fieldList": "

The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.

" + "ValidationException$fieldList": "

The field that caused the error, if applicable.

" } }, "ValidationExceptionReason": { @@ -769,69 +769,69 @@ "WorkspaceAlias": { "base": "

A user-assigned workspace alias.

", "refs": { - "CreateWorkspaceRequest$alias": "

An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.

", - "ListWorkspacesRequest$alias": "

Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.

", - "UpdateWorkspaceAliasRequest$alias": "

The new alias of the workspace.

", - "WorkspaceDescription$alias": "

Alias of this workspace.

", - "WorkspaceSummary$alias": "

Alias of this workspace.

" + "CreateWorkspaceRequest$alias": "

An alias that you assign to this workspace to help you identify it. It does not need to be unique.

Blank spaces at the beginning or end of the alias that you specify will be trimmed from the value used.

", + "ListWorkspacesRequest$alias": "

If this is included, it filters the results to only the workspaces with names that start with the value that you specify here.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

", + "UpdateWorkspaceAliasRequest$alias": "

The new alias for the workspace. It does not need to be unique.

Amazon Managed Service for Prometheus will automatically strip any blank spaces from the beginning and end of the alias that you specify.

", + "WorkspaceDescription$alias": "

The alias that is assigned to this workspace to help identify it. It may not be unique.

", + "WorkspaceSummary$alias": "

The alias that is assigned to this workspace to help identify it. It may not be unique.

" } }, "WorkspaceArn": { "base": "

An ARN identifying a Workspace.

", "refs": { - "AmpConfiguration$workspaceArn": "

The ARN of an AMP workspace.

", - "CreateWorkspaceResponse$arn": "

The ARN of the workspace that was just created.

", - "WorkspaceDescription$arn": "

The Amazon Resource Name (ARN) of this workspace.

", - "WorkspaceSummary$arn": "

The AmazonResourceName of this workspace.

" + "AmpConfiguration$workspaceArn": "

ARN of the Amazon Managed Service for Prometheus workspace.

", + "CreateWorkspaceResponse$arn": "

The ARN for the new workspace.

", + "WorkspaceDescription$arn": "

The ARN of the workspace.

", + "WorkspaceSummary$arn": "

The ARN of the workspace.

" } }, "WorkspaceDescription": { - "base": "

Represents the properties of a workspace.

", + "base": "

The full details about one Amazon Managed Service for Prometheus workspace in your account.

", "refs": { - "DescribeWorkspaceResponse$workspace": "

The properties of the selected workspace.

" + "DescribeWorkspaceResponse$workspace": "

A structure that contains details about the workspace.

" } }, "WorkspaceId": { "base": "

A workspace ID.

", "refs": { - "CreateAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace in which to create the alert manager definition.

", - "CreateLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to vend logs to.

", - "CreateRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace in which to create the rule group namespace.

", - "CreateWorkspaceResponse$workspaceId": "

The generated ID of the workspace that was just created.

", - "DeleteAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace in which to delete the alert manager definition.

", - "DeleteLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to vend logs to.

", - "DeleteRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace to delete rule group definition.

", + "CreateAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace to add the alert manager definition to.

", + "CreateLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to create the logging configuration for.

", + "CreateRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace to add the rule groups namespace.

", + "CreateWorkspaceResponse$workspaceId": "

The unique ID for the new workspace.

", + "DeleteAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace to delete the alert manager definition from.

", + "DeleteLoggingConfigurationRequest$workspaceId": "

The ID of the workspace containing the logging configuration to delete.

", + "DeleteRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace containing the rule groups namespace and definition to delete.

", "DeleteWorkspaceRequest$workspaceId": "

The ID of the workspace to delete.

", - "DescribeAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace to describe.

", - "DescribeLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to vend logs to.

", - "DescribeRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace to describe.

", + "DescribeAlertManagerDefinitionRequest$workspaceId": "

The ID of the workspace to retrieve the alert manager definition from.

", + "DescribeLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to describe the logging configuration for.

", + "DescribeRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace containing the rule groups namespace.

", "DescribeWorkspaceRequest$workspaceId": "

The ID of the workspace to describe.

", - "ListRuleGroupsNamespacesRequest$workspaceId": "

The ID of the workspace.

", - "LoggingConfigurationMetadata$workspace": "

The workspace where the logging configuration exists.

", - "PutAlertManagerDefinitionRequest$workspaceId": "

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

", - "PutRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace in which to update the rule group namespace.

", - "UpdateLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to vend logs to.

", - "UpdateWorkspaceAliasRequest$workspaceId": "

The ID of the workspace being updated.

", - "WorkspaceDescription$workspaceId": "

Unique string identifying this workspace.

", - "WorkspaceSummary$workspaceId": "

Unique string identifying this workspace.

" + "ListRuleGroupsNamespacesRequest$workspaceId": "

The ID of the workspace containing the rule groups namespaces.

", + "LoggingConfigurationMetadata$workspace": "

The ID of the workspace the logging configuration is for.

", + "PutAlertManagerDefinitionRequest$workspaceId": "

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

", + "PutRuleGroupsNamespaceRequest$workspaceId": "

The ID of the workspace where you are updating the rule groups namespace.

", + "UpdateLoggingConfigurationRequest$workspaceId": "

The ID of the workspace to update the logging configuration for.

", + "UpdateWorkspaceAliasRequest$workspaceId": "

The ID of the workspace to update.

", + "WorkspaceDescription$workspaceId": "

The unique ID for the workspace.

", + "WorkspaceSummary$workspaceId": "

The unique ID for the workspace.

" } }, "WorkspaceStatus": { - "base": "

Represents the status of a workspace.

", + "base": "

The status of the workspace.

", "refs": { - "CreateWorkspaceResponse$status": "

The status of the workspace that was just created (usually CREATING).

", - "WorkspaceDescription$status": "

The status of this workspace.

", - "WorkspaceSummary$status": "

The status of this workspace.

" + "CreateWorkspaceResponse$status": "

The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.

", + "WorkspaceDescription$status": "

The current status of the workspace.

", + "WorkspaceSummary$status": "

The current status of the workspace.

" } }, "WorkspaceStatusCode": { "base": "

State of a workspace.

", "refs": { - "WorkspaceStatus$statusCode": "

Status code of this workspace.

" + "WorkspaceStatus$statusCode": "

The current status of the workspace.

" } }, "WorkspaceSummary": { - "base": "

Represents a summary of the properties of a workspace.

", + "base": "

The information about one Amazon Managed Service for Prometheus workspace in your account.

", "refs": { "WorkspaceSummaryList$member": null } @@ -839,7 +839,7 @@ "WorkspaceSummaryList": { "base": "

A list of workspace summaries.

", "refs": { - "ListWorkspacesResponse$workspaces": "

The list of existing workspaces, including those undergoing creation or deletion.

" + "ListWorkspacesResponse$workspaces": "

An array of WorkspaceSummary structures containing information about the workspaces requested.

" } } } diff --git a/apis/batch/2016-08-10/api-2.json b/apis/batch/2016-08-10/api-2.json index 5a01de497c2..193b5cc4ccd 100644 --- a/apis/batch/2016-08-10/api-2.json +++ b/apis/batch/2016-08-10/api-2.json @@ -592,7 +592,8 @@ "networkConfiguration":{"shape":"NetworkConfiguration"}, "fargatePlatformConfiguration":{"shape":"FargatePlatformConfiguration"}, "ephemeralStorage":{"shape":"EphemeralStorage"}, - "runtimePlatform":{"shape":"RuntimePlatform"} + "runtimePlatform":{"shape":"RuntimePlatform"}, + "repositoryCredentials":{"shape":"RepositoryCredentials"} } }, "ContainerOverrides":{ @@ -646,7 +647,8 @@ "networkConfiguration":{"shape":"NetworkConfiguration"}, "fargatePlatformConfiguration":{"shape":"FargatePlatformConfiguration"}, "ephemeralStorage":{"shape":"EphemeralStorage"}, - "runtimePlatform":{"shape":"RuntimePlatform"} + "runtimePlatform":{"shape":"RuntimePlatform"}, + "repositoryCredentials":{"shape":"RepositoryCredentials"} } }, "ContainerSummary":{ @@ -1667,6 +1669,13 @@ "revision":{"shape":"Integer"} } }, + "RepositoryCredentials":{ + "type":"structure", + "required":["credentialsParameter"], + "members":{ + "credentialsParameter":{"shape":"String"} + } + }, "ResourceRequirement":{ "type":"structure", "required":[ diff --git a/apis/batch/2016-08-10/docs-2.json b/apis/batch/2016-08-10/docs-2.json index b0a717cffda..f5ced0fbc7a 100644 --- a/apis/batch/2016-08-10/docs-2.json +++ b/apis/batch/2016-08-10/docs-2.json @@ -134,7 +134,7 @@ "CRAllocationStrategy": { "base": null, "refs": { - "ComputeResource$allocationStrategy": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT (default)

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.

BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "ComputeResource$allocationStrategy": "

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT (default)

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.

BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" } }, "CRType": { @@ -147,7 +147,7 @@ "CRUpdateAllocationStrategy": { "base": null, "refs": { - "ComputeResourceUpdate$allocationStrategy": "

The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With both BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" + "ComputeResourceUpdate$allocationStrategy": "

The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

" } }, "CancelJobRequest": { @@ -549,7 +549,7 @@ "base": "

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

", "refs": { "EksPodProperties$metadata": "

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

", - "EksPodPropertiesDetail$metadata": null, + "EksPodPropertiesDetail$metadata": "

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

", "EksPodPropertiesOverride$metadata": "

Metadata about the overrides for the container that's used on the Amazon EKS pod.

" } }, @@ -678,7 +678,7 @@ "ImageType": { "base": null, "refs": { - "Ec2Configuration$imageType": "

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

ECS

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.

ECS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL1

Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

EKS

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

EKS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

EKS_AL2_NVIDIA

Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

" + "Ec2Configuration$imageType": "

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

ECS

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.

ECS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL2023

Amazon Linux 2023: Batch supports Amazon Linux 2023.

Amazon Linux 2023 does not support A1 instances.
ECS_AL1

Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

EKS

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

EKS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

EKS_AL2_NVIDIA

Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

" } }, "Integer": { @@ -694,11 +694,11 @@ "ComputeEnvironmentDetail$unmanagedvCpus": "

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

", "ComputeEnvironmentOrder$order": "

The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

", "ComputeResource$minvCpus": "

The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", - "ComputeResource$maxvCpus": "

The maximum number of vCPUs that a compute environment can support.

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.

", + "ComputeResource$maxvCpus": "

The maximum number of vCPUs that a compute environment can support.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

", "ComputeResource$desiredvCpus": "

The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResource$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResourceUpdate$minvCpus": "

The minimum number of vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", - "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, and SPOT_PRICE_CAPACITY_OPTIMIZED allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.

", + "ComputeResourceUpdate$maxvCpus": "

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

", "ComputeResourceUpdate$desiredvCpus": "

The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters.

When you update the desiredvCpus setting, the value must be between the minvCpus and maxvCpus values.

Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting Batch in the Batch User Guide.

", "ComputeResourceUpdate$bidPercentage": "

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ContainerDetail$vcpus": "

The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

", @@ -719,7 +719,7 @@ "EksContainerDetail$exitCode": "

The exit code for the job attempt. A non-zero exit code is considered failed.

", "EphemeralStorage$sizeInGiB": "

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

", "FairsharePolicy$shareDecaySeconds": "

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

", - "FairsharePolicy$computeReservation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

", + "FairsharePolicy$computeReservation": "

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

", "JobDefinition$revision": "

The revision of the job definition.

", "JobDefinition$schedulingPriority": "

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

", "JobDetail$schedulingPriority": "

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

", @@ -739,9 +739,9 @@ "RegisterJobDefinitionRequest$schedulingPriority": "

The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

", "RegisterJobDefinitionResponse$revision": "

The revision of the job definition.

", "RetryStrategy$attempts": "

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

", - "SubmitJobRequest$schedulingPriorityOverride": "

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition.

The minimum supported value is 0 and the maximum supported value is 9999.

", + "SubmitJobRequest$schedulingPriorityOverride": "

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

The minimum supported value is 0 and the maximum supported value is 9999.

", "Tmpfs$size": "

The size (in MiB) of the tmpfs volume.

", - "Ulimit$hardLimit": "

The hard limit for the ulimit type.

", + "Ulimit$hardLimit": "

The hard limit for the ulimit type.

", "Ulimit$softLimit": "

The soft limit for the ulimit type.

", "UpdateComputeEnvironmentRequest$unmanagedvCpus": "

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

", "UpdateJobQueueRequest$priority": "

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

" @@ -948,7 +948,7 @@ "EksContainerSecurityContext$runAsUser": "

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

", "EksContainerSecurityContext$runAsGroup": "

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

", "JobDetail$createdAt": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

", - "JobDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state. This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

", + "JobDetail$startedAt": "

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

", "JobDetail$stoppedAt": "

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

", "JobSummary$createdAt": "

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

", "JobSummary$startedAt": "

The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

", @@ -956,7 +956,7 @@ } }, "MountPoint": { - "base": "

Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", + "base": "

Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

", "refs": { "MountPoints$member": null } @@ -1086,6 +1086,13 @@ "refs": { } }, + "RepositoryCredentials": { + "base": "

The repository credentials for private registry authentication.

", + "refs": { + "ContainerDetail$repositoryCredentials": "

The private repository authentication credentials to use.

", + "ContainerProperties$repositoryCredentials": "

The private repository authentication credentials to use.

" + } + }, "ResourceRequirement": { "base": "

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

", "refs": { @@ -1122,10 +1129,10 @@ } }, "RuntimePlatform": { - "base": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

", + "base": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

", "refs": { - "ContainerDetail$runtimePlatform": null, - "ContainerProperties$runtimePlatform": null + "ContainerDetail$runtimePlatform": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

", + "ContainerProperties$runtimePlatform": "

An object that represents the compute environment architecture for Batch jobs on Fargate.

" } }, "SchedulingPolicyDetail": { @@ -1204,11 +1211,11 @@ "ComputeEnvironmentOrder$computeEnvironment": "

The Amazon Resource Name (ARN) of the compute environment.

", "ComputeResource$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", "ComputeResource$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", - "ComputeResource$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResource$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResource$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResource$spotIamFleetRole": "

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

", "ComputeResourceUpdate$ec2KeyPair": "

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", - "ComputeResourceUpdate$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", + "ComputeResourceUpdate$instanceRole": "

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResourceUpdate$placementGroup": "

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

", "ComputeResourceUpdate$imageId": "

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

", "ContainerDetail$image": "

The image used to start the container.

", @@ -1221,7 +1228,7 @@ "ContainerDetail$logStreamName": "

The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

", "ContainerDetail$instanceType": "

The instance type of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

", "ContainerOverrides$instanceType": "

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

", - "ContainerProperties$image": "

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

 ", + "ContainerProperties$image": "

Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

 ", "ContainerProperties$jobRoleArn": "

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

", "ContainerProperties$executionRoleArn": "

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

", "ContainerProperties$user": "

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

", @@ -1341,9 +1348,10 @@ "RegisterJobDefinitionRequest$jobDefinitionName": "

The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

", "RegisterJobDefinitionResponse$jobDefinitionName": "

The name of the job definition.

", "RegisterJobDefinitionResponse$jobDefinitionArn": "

The Amazon Resource Name (ARN) of the job definition.

", + "RepositoryCredentials$credentialsParameter": "

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

", "ResourceRequirement$value": "

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type=\"GPU\"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.
type=\"MEMORY\"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type=\"VCPU\"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

", - "RuntimePlatform$operatingSystemFamily": "

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks before registering a task definition with Fargate. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for Windows-based containers on Fargate. A job queue will be blocked if a Fargate Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

", - "RuntimePlatform$cpuArchitecture": "

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

", + "RuntimePlatform$operatingSystemFamily": "

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

", + "RuntimePlatform$cpuArchitecture": "

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

", "SchedulingPolicyDetail$name": "

The name of the scheduling policy.

", "SchedulingPolicyDetail$arn": "

The Amazon Resource Name (ARN) of the scheduling policy. An example is arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .

", "SchedulingPolicyListingDetail$arn": "

Amazon Resource Name (ARN) of the scheduling policy.

", @@ -1365,7 +1373,7 @@ "TerminateJobRequest$jobId": "

The Batch job ID of the job to terminate.

", "TerminateJobRequest$reason": "

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

", "Tmpfs$containerPath": "

The absolute file path in the container where the tmpfs volume is mounted.

", - "Ulimit$name": "

The type of the ulimit.

", + "Ulimit$name": "

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

", "UntagResourceRequest$resourceArn": "

The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

", "UpdateComputeEnvironmentRequest$computeEnvironment": "

The name or full Amazon Resource Name (ARN) of the compute environment to update.

", "UpdateComputeEnvironmentRequest$serviceRole": "

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

", @@ -1392,7 +1400,7 @@ "ContainerOverrides$command": "

The command to send to the container that overrides the default command from the Docker image or the job definition.

This parameter can't contain an empty string.

", "ContainerProperties$command": "

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

", "DescribeComputeEnvironmentsRequest$computeEnvironments": "

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

", - "DescribeJobDefinitionsRequest$jobDefinitions": "

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}.

", + "DescribeJobDefinitionsRequest$jobDefinitions": "

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

", "DescribeJobQueuesRequest$jobQueues": "

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

", "DescribeJobsRequest$jobs": "

A list of up to 100 job IDs.

", "DescribeSchedulingPoliciesRequest$arns": "

A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

", @@ -1492,7 +1500,7 @@ } }, "Ulimit": { - "base": "

The ulimit settings to pass to the container.

This object isn't applicable to jobs that are running on Fargate resources.

", + "base": "

The ulimit settings to pass to the container. For more information, see Ulimit.

This object isn't applicable to jobs that are running on Fargate resources.

", "refs": { "Ulimits$member": null } diff --git a/apis/batch/2016-08-10/endpoint-rule-set-1.json b/apis/batch/2016-08-10/endpoint-rule-set-1.json index d04df9721c1..54954abbb7a 100644 --- a/apis/batch/2016-08-10/endpoint-rule-set-1.json +++ b/apis/batch/2016-08-10/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,18 +212,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws", { "fn": "getAttr", "argv": [ @@ -236,7 +231,8 @@ }, "name" ] - } + }, + "aws" ] } ], @@ -252,7 +248,6 @@ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -261,7 +256,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -281,14 +277,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -302,7 +300,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -322,7 +319,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -333,14 +329,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -351,9 +349,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/apis/braket/2019-09-01/api-2.json b/apis/braket/2019-09-01/api-2.json index cf1fa7b5473..26f37039d41 100644 --- a/apis/braket/2019-09-01/api-2.json +++ b/apis/braket/2019-09-01/api-2.json @@ -63,6 +63,7 @@ {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, + {"shape":"DeviceOfflineException"}, {"shape":"DeviceRetiredException"}, {"shape":"InternalServiceException"}, {"shape":"ServiceQuotaExceededException"}, @@ -848,7 +849,7 @@ }, "JobArn":{ "type":"string", - "pattern":"^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]*:[0-9]{12}:job/.*$" + "pattern":"^arn:aws[a-z\\-]*:braket:[a-z0-9\\-]+:[0-9]{12}:job/.*$" }, "JobCheckpointConfig":{ "type":"structure", diff --git a/apis/cost-optimization-hub/2022-07-26/api-2.json b/apis/cost-optimization-hub/2022-07-26/api-2.json index b53396cb305..9df87de89fa 100644 --- a/apis/cost-optimization-hub/2022-07-26/api-2.json +++ b/apis/cost-optimization-hub/2022-07-26/api-2.json @@ -473,6 +473,7 @@ "ListEnrollmentStatusesResponse":{ "type":"structure", "members":{ + "includeMemberAccounts":{"shape":"Boolean"}, "items":{"shape":"AccountEnrollmentStatuses"}, "nextToken":{"shape":"String"} } diff --git a/apis/cost-optimization-hub/2022-07-26/docs-2.json b/apis/cost-optimization-hub/2022-07-26/docs-2.json index f55a95ff265..182d23c4e5b 100644 --- a/apis/cost-optimization-hub/2022-07-26/docs-2.json +++ b/apis/cost-optimization-hub/2022-07-26/docs-2.json @@ -25,7 +25,7 @@ "AccountEnrollmentStatuses": { "base": null, "refs": { - "ListEnrollmentStatusesResponse$items": "

The account enrollment statuses.

" + "ListEnrollmentStatusesResponse$items": "

The enrollment status of a specific account ID, including creation and last updated timestamps.

" } }, "AccountId": { @@ -33,7 +33,7 @@ "refs": { "AccountEnrollmentStatus$accountId": "

The Amazon Web Services account ID.

", "AccountIdList$member": null, - "ListEnrollmentStatusesRequest$accountId": "

The enrollment status of a specific account ID in the organization.

" + "ListEnrollmentStatusesRequest$accountId": "

The account ID of a member account in the organization.

" } }, "AccountIdList": { @@ -70,6 +70,7 @@ "Filter$rollbackPossible": "

Whether or not implementing the recommendation can be rolled back.

", "GetRecommendationResponse$restartNeeded": "

Whether or not implementing the recommendation requires a restart.

", "GetRecommendationResponse$rollbackPossible": "

Whether or not implementing the recommendation can be rolled back.

", + "ListEnrollmentStatusesResponse$includeMemberAccounts": "

The enrollment status of all member accounts in the organization if the account is the management account.

", "OpenSearchReservedInstancesConfiguration$sizeFlexEligible": "

Determines whether the recommendation is size flexible.

", "RdsReservedInstancesConfiguration$sizeFlexEligible": "

Determines whether the recommendation is size flexible.

", "Recommendation$restartNeeded": "

Whether or not implementing the recommendation requires a restart.

", diff --git a/apis/ecs/2014-11-13/docs-2.json b/apis/ecs/2014-11-13/docs-2.json index ef6dbb5baac..35061cbb538 100644 --- a/apis/ecs/2014-11-13/docs-2.json +++ b/apis/ecs/2014-11-13/docs-2.json @@ -35,7 +35,7 @@ "ListTaskDefinitionFamilies": "

Returns a list of task definition families that are registered to your account. This list includes task definition families that no longer have any ACTIVE task definition revisions.

You can filter out task definition families that don't contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

", "ListTaskDefinitions": "

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

", "ListTasks": "

Returns a list of tasks. You can filter the results by cluster, task definition family, container instance, launch type, what IAM principal started the task, or by the desired status of the task.

Recently stopped tasks might appear in the returned results.

", - "PutAccountSetting": "

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

When you specify serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified user, role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource is defined by the opt-in status of the user or role that created the resource. You must turn on this setting to use Amazon ECS features such as resource tagging.

When you specify awsvpcTrunking, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is turned on, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

When you specify containerInsights, the default setting indicating whether Amazon Web Services CloudWatch Container Insights is turned on for your clusters is changed. If containerInsights is turned on, any new clusters that are created will have Container Insights turned on unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

Amazon ECS is introducing tagging authorization for resource creation. Users must have permissions for actions that create the resource, such as ecsCreateCluster. If tags are specified when you create a resource, Amazon Web Services performs additional authorization to verify if users or roles have permissions to create tags. Therefore, you must grant explicit permissions to use the ecs:TagResource action. For more information, see Grant permission to tag resources on creation in the Amazon ECS Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to configure the wait time to retire a Fargate task. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

", + "PutAccountSetting": "

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the root user account setting, the default settings are reset for users and roles that do not have specified individual account settings. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

", "PutAccountSettingDefault": "

Modifies an account setting for all users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

", "PutAttributes": "

Create or update an attribute on an Amazon ECS resource. If the attribute doesn't exist, it's created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

", "PutClusterCapacityProviders": "

Modifies the available capacity providers and the default capacity provider strategy for a cluster.

You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers that are associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. We recommend that you define a default capacity provider strategy for your cluster. However, you must specify an empty array ([]) to bypass defining a default strategy.

", @@ -1058,7 +1058,7 @@ "DescribeTaskSetsResponse$failures": "

Any failures associated with the call.

", "DescribeTasksResponse$failures": "

Any failures associated with the call.

", "GetTaskProtectionResponse$failures": "

Any failures associated with the call.

", - "RunTaskResponse$failures": "

Any failures associated with the call.

", + "RunTaskResponse$failures": "

Any failures associated with the call.

For information about how to address failures, see Service event messages and API failure reasons in the Amazon Elastic Container Service Developer Guide.

", "StartTaskResponse$failures": "

Any failures associated with the call.

", "UpdateContainerInstancesStateResponse$failures": "

Any failures associated with the call.

", "UpdateTaskProtectionResponse$failures": "

Any failures associated with the call.

" @@ -2057,8 +2057,8 @@ "refs": { "DeleteAccountSettingRequest$name": "

The resource name to disable the account setting for. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

", "ListAccountSettingsRequest$name": "

The name of the account setting you want to list the settings for.

", - "PutAccountSettingDefaultRequest$name": "

The resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the ENI limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the default wait time to retire a Fargate task due to required maintenance is affected.

When you specify fargateFIPSMode for the name and enabled for the value, Fargate uses FIPS-140 compliant cryptographic algorithms on your tasks. For more information about FIPS-140 compliance with Fargate, see Amazon Web Services Fargate Federal Information Processing Standard (FIPS) 140-2 compliance in the Amazon Elastic Container Service Developer Guide.

When Amazon Web Services determines that a security or infrastructure update is needed for an Amazon ECS task hosted on Fargate, the tasks need to be stopped and new tasks launched to replace them. Use fargateTaskRetirementWaitPeriod to set the wait time to retire a Fargate task to the default. For information about the Fargate tasks maintenance, see Amazon Web Services Fargate task maintenance in the Amazon ECS Developer Guide.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

", - "PutAccountSettingRequest$name": "

The Amazon ECS resource name for which to modify the account setting. If you specify serviceLongArnFormat, the ARN for your Amazon ECS services is affected. If you specify taskLongArnFormat, the ARN and resource ID for your Amazon ECS tasks is affected. If you specify containerInstanceLongArnFormat, the ARN and resource ID for your Amazon ECS container instances is affected. If you specify awsvpcTrunking, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If you specify containerInsights, the default setting for Amazon Web Services CloudWatch Container Insights for your clusters is affected. If you specify fargateFIPSMode, Fargate FIPS 140 compliance is affected. If you specify tagResourceAuthorization, the opt-in option for tagging resources on creation is affected. For information about the opt-in timeline, see Tagging authorization timeline in the Amazon ECS Developer Guide. If you specify fargateTaskRetirementWaitPeriod, the wait time to retire a Fargate task is affected.

The guardDutyActivate parameter is read-only in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is enabled or disabled by your security administrator in your Amazon ECS account. Amazon GuardDuty controls this account setting on your behalf. For more information, see Protecting Amazon ECS workloads with Amazon ECS Runtime Monitoring.

", + "PutAccountSettingDefaultRequest$name": "

The resource name for which to modify the account setting.

The following are the valid values for the account setting name.

", + "PutAccountSettingRequest$name": "

The Amazon ECS account setting name to modify.

The following are the valid values for the account setting name.

", "Setting$name": "

The Amazon ECS resource name.

" } }, diff --git a/apis/iot/2015-05-28/api-2.json b/apis/iot/2015-05-28/api-2.json index e19ba06561c..1710a59c680 100644 --- a/apis/iot/2015-05-28/api-2.json +++ b/apis/iot/2015-05-28/api-2.json @@ -5795,7 +5795,8 @@ "authorizerConfig":{"shape":"AuthorizerConfig"}, "serviceType":{"shape":"ServiceType"}, "tags":{"shape":"TagList"}, - "tlsConfig":{"shape":"TlsConfig"} + "tlsConfig":{"shape":"TlsConfig"}, + "serverCertificateConfig":{"shape":"ServerCertificateConfig"} } }, "CreateDomainConfigurationResponse":{ @@ -7427,7 +7428,8 @@ "serviceType":{"shape":"ServiceType"}, "domainType":{"shape":"DomainType"}, "lastStatusChangeDate":{"shape":"DateType"}, - "tlsConfig":{"shape":"TlsConfig"} + "tlsConfig":{"shape":"TlsConfig"}, + "serverCertificateConfig":{"shape":"ServerCertificateConfig"} } }, "DescribeEndpointRequest":{ @@ -8282,6 +8284,7 @@ "logLevel":{"shape":"LogLevel"} } }, + "EnableOCSPCheck":{"type":"boolean"}, "EnableTopicRuleRequest":{ "type":"structure", "required":["ruleName"], @@ -12841,6 +12844,12 @@ "max":1, "min":0 }, + "ServerCertificateConfig":{ + "type":"structure", + "members":{ + "enableOCSPCheck":{"shape":"EnableOCSPCheck"} + } + }, "ServerCertificateStatus":{ "type":"string", "enum":[ @@ -14215,7 +14224,8 @@ "authorizerConfig":{"shape":"AuthorizerConfig"}, "domainConfigurationStatus":{"shape":"DomainConfigurationStatus"}, "removeAuthorizerConfig":{"shape":"RemoveAuthorizerConfig"}, - "tlsConfig":{"shape":"TlsConfig"} + "tlsConfig":{"shape":"TlsConfig"}, + "serverCertificateConfig":{"shape":"ServerCertificateConfig"} } }, "UpdateDomainConfigurationResponse":{ diff --git a/apis/iot/2015-05-28/docs-2.json b/apis/iot/2015-05-28/docs-2.json index 90f403ec866..e81c0f69c8c 100644 --- a/apis/iot/2015-05-28/docs-2.json +++ b/apis/iot/2015-05-28/docs-2.json @@ -99,7 +99,7 @@ "DescribeDetectMitigationActionsTask": "

Gets information about a Device Defender ML Detect mitigation action.

Requires permission to access the DescribeDetectMitigationActionsTask action.

", "DescribeDimension": "

Provides details about a dimension that is defined in your Amazon Web Services accounts.

Requires permission to access the DescribeDimension action.

", "DescribeDomainConfiguration": "

Gets summary information about a domain configuration.

Requires permission to access the DescribeDomainConfiguration action.

", - "DescribeEndpoint": "

Returns a unique endpoint specific to the Amazon Web Services account making the call.

Requires permission to access the DescribeEndpoint action.

", + "DescribeEndpoint": "

Returns or creates a unique endpoint specific to the Amazon Web Services account making the call.

The first time DescribeEndpoint is called, an endpoint is created. All subsequent calls to DescribeEndpoint return the same endpoint.

Requires permission to access the DescribeEndpoint action.

", "DescribeEventConfigurations": "

Describes event configurations.

Requires permission to access the DescribeEventConfigurations action.

", "DescribeFleetMetric": "

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

", "DescribeIndex": "

Describes a search index.

Requires permission to access the DescribeIndex action.

", @@ -138,7 +138,7 @@ "GetPercentiles": "

Groups the aggregated values that match the query into percentile groupings. The default percentile groupings are: 1,5,25,50,75,95,99, although you can specify your own when you call GetPercentiles. This function returns a value for each percentile group specified (or the default percentile groupings). The percentile group \"1\" contains the aggregated field value that occurs in approximately one percent of the values that match the query. The percentile group \"5\" contains the aggregated field value that occurs in approximately five percent of the values that match the query, and so on. The result is an approximation, the more values that match the query, the more accurate the percentile values.

Requires permission to access the GetPercentiles action.

", "GetPolicy": "

Gets information about the specified policy with the policy document of the default version.

Requires permission to access the GetPolicy action.

", "GetPolicyVersion": "

Gets information about the specified policy version.

Requires permission to access the GetPolicyVersion action.

", - "GetRegistrationCode": "

Gets a registration code used to register a CA certificate with IoT.

Requires permission to access the GetRegistrationCode action.

", + "GetRegistrationCode": "

Gets a registration code used to register a CA certificate with IoT.

IoT will create a registration code as part of this API call if the registration code doesn't exist or has been deleted. If you already have a registration code, this API call will return the same registration code.

Requires permission to access the GetRegistrationCode action.

", "GetStatistics": "

Returns the count, average, sum, minimum, maximum, sum of squares, variance, and standard deviation for the specified aggregated field. If the aggregation field is of type String, only the count statistic is returned.

Requires permission to access the GetStatistics action.

", "GetTopicRule": "

Gets information about the rule.

Requires permission to access the GetTopicRule action.

", "GetTopicRuleDestination": "

Gets information about a topic rule destination.

Requires permission to access the GetTopicRuleDestination action.

", @@ -3458,6 +3458,12 @@ "MitigationActionParams$enableIoTLoggingParams": "

Parameters to define a mitigation action that enables Amazon Web Services IoT Core logging at a specified level of detail.

" } }, + "EnableOCSPCheck": { + "base": null, + "refs": { + "ServerCertificateConfig$enableOCSPCheck": "

A Boolean value that indicates whether Online Certificate Status Protocol (OCSP) server certificate check is enabled or not.

For more information, see Configuring OCSP server-certificate stapling in domain configuration from Amazon Web Services IoT Core Developer Guide.

" + } + }, "EnableTopicRuleRequest": { "base": "

The input for the EnableTopicRuleRequest operation.

", "refs": { @@ -7383,6 +7389,14 @@ "CreateDomainConfigurationRequest$serverCertificateArns": "

The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

" } }, + "ServerCertificateConfig": { + "base": "

The server certificate configuration.

", + "refs": { + "CreateDomainConfigurationRequest$serverCertificateConfig": "

The server certificate configuration.

", + "DescribeDomainConfigurationResponse$serverCertificateConfig": "

The server certificate configuration.

", + "UpdateDomainConfigurationRequest$serverCertificateConfig": "

The server certificate configuration.

" + } + }, "ServerCertificateStatus": { "base": null, "refs": { diff --git a/apis/pricing/2017-10-15/api-2.json b/apis/pricing/2017-10-15/api-2.json index 3f1032f32d2..3c9d439e8ab 100644 --- a/apis/pricing/2017-10-15/api-2.json +++ b/apis/pricing/2017-10-15/api-2.json @@ -27,6 +27,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ] }, @@ -43,6 +44,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ] }, @@ -58,7 +60,8 @@ {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"InternalErrorException"} + {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"} ] }, "GetProducts":{ @@ -74,6 +77,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ] }, @@ -91,6 +95,7 @@ {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ] } @@ -244,7 +249,8 @@ "Message":{"shape":"errorMessage"} }, "exception":true, - "fault":true + "fault":true, + "retryable":{"throttling":false} }, "InvalidNextTokenException":{ "type":"structure", @@ -309,7 +315,7 @@ "type":"string", "max":2048, "min":18, - "pattern":"arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9_/.-]{1,1023}" + "pattern":"arn:[A-Za-z0-9][-.A-Za-z0-9]{0,62}:pricing:::price-list/[A-Za-z0-9+_/.-]{1,1023}" }, "PriceListJsonItems":{ "type":"list", @@ -346,6 +352,14 @@ }, "String":{"type":"string"}, "SynthesizedJsonPriceListJsonItem":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "exception":true, + "retryable":{"throttling":true} + }, "errorMessage":{"type":"string"} } } diff --git a/apis/pricing/2017-10-15/docs-2.json b/apis/pricing/2017-10-15/docs-2.json index cc39aa3ba00..19b1e4f94c9 100644 --- a/apis/pricing/2017-10-15/docs-2.json +++ b/apis/pricing/2017-10-15/docs-2.json @@ -248,6 +248,11 @@ "PriceListJsonItems$member": null } }, + "ThrottlingException": { + "base": "

You've made too many requests exceeding service quotas.

", + "refs": { + } + }, "errorMessage": { "base": null, "refs": { @@ -256,7 +261,8 @@ "InternalErrorException$Message": null, "InvalidNextTokenException$Message": null, "InvalidParameterException$Message": null, - "NotFoundException$Message": null + "NotFoundException$Message": null, + "ThrottlingException$Message": null } } } diff --git a/apis/pricing/2017-10-15/endpoint-rule-set-1.json b/apis/pricing/2017-10-15/endpoint-rule-set-1.json index a87f285e6f4..309ef25b584 100644 --- a/apis/pricing/2017-10-15/endpoint-rule-set-1.json +++ b/apis/pricing/2017-10-15/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -83,7 +82,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -96,7 +96,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -110,7 +109,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -133,7 +131,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -168,7 +165,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -179,14 +175,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -200,14 +198,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -216,11 +212,11 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -231,14 +227,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -252,7 +250,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -272,7 +269,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -283,14 +279,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -326,9 +324,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], diff --git a/gems/aws-partitions/CHANGELOG.md b/gems/aws-partitions/CHANGELOG.md index b20f43a68b6..10c821f8f29 100644 --- a/gems/aws-partitions/CHANGELOG.md +++ b/gems/aws-partitions/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.889.0 (2024-02-09) +------------------ + +* Feature - Updated the partitions source data the determines the AWS service regions and endpoints. + 1.888.0 (2024-02-07) ------------------ diff --git a/gems/aws-partitions/VERSION b/gems/aws-partitions/VERSION index 29e753448d2..9963e59777a 100644 --- a/gems/aws-partitions/VERSION +++ b/gems/aws-partitions/VERSION @@ -1 +1 @@ -1.888.0 +1.889.0 diff --git a/gems/aws-partitions/partitions.json b/gems/aws-partitions/partitions.json index c7687dd4ec6..66628592e43 100644 --- a/gems/aws-partitions/partitions.json +++ b/gems/aws-partitions/partitions.json @@ -23279,6 +23279,12 @@ "us-gov-west-1" : { } } }, + "emr-serverless" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "es" : { "endpoints" : { "fips" : { diff --git a/gems/aws-sdk-batch/CHANGELOG.md b/gems/aws-sdk-batch/CHANGELOG.md index b149fe681c0..9a0e38eddaf 100644 --- a/gems/aws-sdk-batch/CHANGELOG.md +++ b/gems/aws-sdk-batch/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.81.0 (2024-02-09) +------------------ + +* Feature - This feature allows Batch to support configuration of repository credentials for jobs running on ECS + 1.80.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-batch/VERSION b/gems/aws-sdk-batch/VERSION index aaceec04e04..dbd41264aa9 100644 --- a/gems/aws-sdk-batch/VERSION +++ b/gems/aws-sdk-batch/VERSION @@ -1 +1 @@ -1.80.0 +1.81.0 diff --git a/gems/aws-sdk-batch/lib/aws-sdk-batch.rb b/gems/aws-sdk-batch/lib/aws-sdk-batch.rb index 6d2e9fa9031..ed4408fdc50 100644 --- a/gems/aws-sdk-batch/lib/aws-sdk-batch.rb +++ b/gems/aws-sdk-batch/lib/aws-sdk-batch.rb @@ -52,6 +52,6 @@ # @!group service module Aws::Batch - GEM_VERSION = '1.80.0' + GEM_VERSION = '1.81.0' end diff --git a/gems/aws-sdk-batch/lib/aws-sdk-batch/client.rb b/gems/aws-sdk-batch/lib/aws-sdk-batch/client.rb index 184efa4ff7c..b65c4498bb3 100644 --- a/gems/aws-sdk-batch/lib/aws-sdk-batch/client.rb +++ b/gems/aws-sdk-batch/lib/aws-sdk-batch/client.rb @@ -1357,7 +1357,8 @@ def describe_compute_environments(params = {}, options = {}) # be an ARN in the format # `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}` # or a short version using the form - # `$\{JobDefinitionName\}:$\{Revision\}`. + # `$\{JobDefinitionName\}:$\{Revision\}`. This parameter can't be used + # with other parameters. # # @option params [Integer] :max_results # The maximum number of results returned by `DescribeJobDefinitions` in @@ -1531,6 +1532,7 @@ def describe_compute_environments(params = {}, options = {}) # resp.job_definitions[0].container_properties.ephemeral_storage.size_in_gi_b #=> Integer # resp.job_definitions[0].container_properties.runtime_platform.operating_system_family #=> String # resp.job_definitions[0].container_properties.runtime_platform.cpu_architecture #=> String + # resp.job_definitions[0].container_properties.repository_credentials.credentials_parameter #=> String # resp.job_definitions[0].timeout.attempt_duration_seconds #=> Integer # resp.job_definitions[0].node_properties.num_nodes #=> Integer # resp.job_definitions[0].node_properties.main_node #=> Integer @@ -1598,6 +1600,7 @@ def describe_compute_environments(params = {}, options = {}) # resp.job_definitions[0].node_properties.node_range_properties[0].container.ephemeral_storage.size_in_gi_b #=> Integer # resp.job_definitions[0].node_properties.node_range_properties[0].container.runtime_platform.operating_system_family #=> String # resp.job_definitions[0].node_properties.node_range_properties[0].container.runtime_platform.cpu_architecture #=> String + # resp.job_definitions[0].node_properties.node_range_properties[0].container.repository_credentials.credentials_parameter #=> String # resp.job_definitions[0].tags #=> Hash # resp.job_definitions[0].tags["TagKey"] #=> String # resp.job_definitions[0].propagate_tags #=> Boolean @@ -1926,6 +1929,7 @@ def describe_job_queues(params = {}, options = {}) # resp.jobs[0].container.ephemeral_storage.size_in_gi_b #=> Integer # resp.jobs[0].container.runtime_platform.operating_system_family #=> String # resp.jobs[0].container.runtime_platform.cpu_architecture #=> String + # resp.jobs[0].container.repository_credentials.credentials_parameter #=> String # resp.jobs[0].node_details.node_index #=> Integer # resp.jobs[0].node_details.is_main_node #=> Boolean # resp.jobs[0].node_properties.num_nodes #=> Integer @@ -1994,6 +1998,7 @@ def describe_job_queues(params = {}, options = {}) # resp.jobs[0].node_properties.node_range_properties[0].container.ephemeral_storage.size_in_gi_b #=> Integer # resp.jobs[0].node_properties.node_range_properties[0].container.runtime_platform.operating_system_family #=> String # resp.jobs[0].node_properties.node_range_properties[0].container.runtime_platform.cpu_architecture #=> String + # resp.jobs[0].node_properties.node_range_properties[0].container.repository_credentials.credentials_parameter #=> String # resp.jobs[0].array_properties.status_summary #=> Hash # resp.jobs[0].array_properties.status_summary["String"] #=> Integer # resp.jobs[0].array_properties.size #=> Integer @@ -2726,6 +2731,9 @@ def list_tags_for_resource(params = {}, options = {}) # operating_system_family: "String", # cpu_architecture: "String", # }, + # repository_credentials: { + # credentials_parameter: "String", # required + # }, # }, # node_properties: { # num_nodes: 1, # required @@ -2839,6 +2847,9 @@ def list_tags_for_resource(params = {}, options = {}) # operating_system_family: "String", # cpu_architecture: "String", # }, + # repository_credentials: { + # credentials_parameter: "String", # required + # }, # }, # }, # ], @@ -2983,7 +2994,8 @@ def register_job_definition(params = {}, options = {}) # The scheduling priority for the job. This only affects jobs in job # queues with a fair share policy. Jobs with a higher scheduling # priority are scheduled before jobs with a lower scheduling priority. - # This overrides any scheduling priority in the job definition. + # This overrides any scheduling priority in the job definition and works + # only within a single share identifier. # # The minimum supported value is 0 and the maximum supported value is # 9999. @@ -3710,7 +3722,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-batch' - context[:gem_version] = '1.80.0' + context[:gem_version] = '1.81.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-batch/lib/aws-sdk-batch/client_api.rb b/gems/aws-sdk-batch/lib/aws-sdk-batch/client_api.rb index 503141d3a7b..e09cd459347 100644 --- a/gems/aws-sdk-batch/lib/aws-sdk-batch/client_api.rb +++ b/gems/aws-sdk-batch/lib/aws-sdk-batch/client_api.rb @@ -171,6 +171,7 @@ module ClientApi Quantity = Shapes::StringShape.new(name: 'Quantity') RegisterJobDefinitionRequest = Shapes::StructureShape.new(name: 'RegisterJobDefinitionRequest') RegisterJobDefinitionResponse = Shapes::StructureShape.new(name: 'RegisterJobDefinitionResponse') + RepositoryCredentials = Shapes::StructureShape.new(name: 'RepositoryCredentials') ResourceRequirement = Shapes::StructureShape.new(name: 'ResourceRequirement') ResourceRequirements = Shapes::ListShape.new(name: 'ResourceRequirements') ResourceType = Shapes::StringShape.new(name: 'ResourceType') @@ -346,6 +347,7 @@ module ClientApi ContainerDetail.add_member(:fargate_platform_configuration, Shapes::ShapeRef.new(shape: FargatePlatformConfiguration, location_name: "fargatePlatformConfiguration")) ContainerDetail.add_member(:ephemeral_storage, Shapes::ShapeRef.new(shape: EphemeralStorage, location_name: "ephemeralStorage")) ContainerDetail.add_member(:runtime_platform, Shapes::ShapeRef.new(shape: RuntimePlatform, location_name: "runtimePlatform")) + ContainerDetail.add_member(:repository_credentials, Shapes::ShapeRef.new(shape: RepositoryCredentials, location_name: "repositoryCredentials")) ContainerDetail.struct_class = Types::ContainerDetail ContainerOverrides.add_member(:vcpus, Shapes::ShapeRef.new(shape: Integer, deprecated: true, location_name: "vcpus", metadata: {"deprecatedMessage"=>"This field is deprecated, use resourceRequirements instead."})) @@ -378,6 +380,7 @@ module ClientApi ContainerProperties.add_member(:fargate_platform_configuration, Shapes::ShapeRef.new(shape: FargatePlatformConfiguration, location_name: "fargatePlatformConfiguration")) ContainerProperties.add_member(:ephemeral_storage, Shapes::ShapeRef.new(shape: EphemeralStorage, location_name: "ephemeralStorage")) ContainerProperties.add_member(:runtime_platform, Shapes::ShapeRef.new(shape: RuntimePlatform, location_name: "runtimePlatform")) + ContainerProperties.add_member(:repository_credentials, Shapes::ShapeRef.new(shape: RepositoryCredentials, location_name: "repositoryCredentials")) ContainerProperties.struct_class = Types::ContainerProperties ContainerSummary.add_member(:exit_code, Shapes::ShapeRef.new(shape: Integer, location_name: "exitCode")) @@ -893,6 +896,9 @@ module ClientApi RegisterJobDefinitionResponse.add_member(:revision, Shapes::ShapeRef.new(shape: Integer, required: true, location_name: "revision")) RegisterJobDefinitionResponse.struct_class = Types::RegisterJobDefinitionResponse + RepositoryCredentials.add_member(:credentials_parameter, Shapes::ShapeRef.new(shape: String, required: true, location_name: "credentialsParameter")) + RepositoryCredentials.struct_class = Types::RepositoryCredentials + ResourceRequirement.add_member(:value, Shapes::ShapeRef.new(shape: String, required: true, location_name: "value")) ResourceRequirement.add_member(:type, Shapes::ShapeRef.new(shape: ResourceType, required: true, location_name: "type")) ResourceRequirement.struct_class = Types::ResourceRequirement diff --git a/gems/aws-sdk-batch/lib/aws-sdk-batch/endpoint_provider.rb b/gems/aws-sdk-batch/lib/aws-sdk-batch/endpoint_provider.rb index 4ec7f612f34..89f506fd800 100644 --- a/gems/aws-sdk-batch/lib/aws-sdk-batch/endpoint_provider.rb +++ b/gems/aws-sdk-batch/lib/aws-sdk-batch/endpoint_provider.rb @@ -32,11 +32,11 @@ def resolve_endpoint(parameters) raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both" end if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) - if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) - if Aws::Endpoints::Matchers.string_equals?("aws", Aws::Endpoints::Matchers.attr(partition_result, "name")) + if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true) + if Aws::Endpoints::Matchers.string_equals?(Aws::Endpoints::Matchers.attr(partition_result, "name"), "aws") return Aws::Endpoints::Endpoint.new(url: "https://fips.batch.#{region}.amazonaws.com", headers: {}, properties: {}) end - if Aws::Endpoints::Matchers.string_equals?("aws-us-gov", Aws::Endpoints::Matchers.attr(partition_result, "name")) + if Aws::Endpoints::Matchers.string_equals?(Aws::Endpoints::Matchers.attr(partition_result, "name"), "aws-us-gov") return Aws::Endpoints::Endpoint.new(url: "https://batch.#{region}.amazonaws.com", headers: {}, properties: {}) end return Aws::Endpoints::Endpoint.new(url: "https://batch-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {}) diff --git a/gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb b/gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb index c71e9a35ed9..7a908bb7f5a 100644 --- a/gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb +++ b/gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb @@ -454,11 +454,11 @@ class ComputeEnvironmentOrder < Struct.new( # compute resources. # # With `BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and - # `SPOT_PRICE_CAPACITY_OPTIMIZED` strategies using On-Demand or Spot - # Instances, and the `BEST_FIT` strategy using Spot Instances, Batch - # might need to exceed `maxvCpus` to meet your capacity requirements. - # In this event, Batch never exceeds `maxvCpus` by more than a single - # instance. + # `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using + # On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot + # Instances, Batch might need to exceed `maxvCpus` to meet your + # capacity requirements. In this event, Batch never exceeds `maxvCpus` + # by more than a single instance. # # # @@ -480,14 +480,12 @@ class ComputeEnvironmentOrder < Struct.new( # @!attribute [rw] maxv_cpus # The maximum number of vCPUs that a compute environment can support. # - # With `BEST_FIT_PROGRESSIVE`, `SPOT_CAPACITY_OPTIMIZED` and - # `SPOT_PRICE_CAPACITY_OPTIMIZED` allocation strategies using + # With `BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and + # `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using # On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot # Instances, Batch might need to exceed `maxvCpus` to meet your # capacity requirements. In this event, Batch never exceeds `maxvCpus` - # by more than a single instance. For example, no more than a single - # instance from among those specified in your compute environment is - # allocated. + # by more than a single instance. # # # @return [Integer] @@ -606,7 +604,8 @@ class ComputeEnvironmentOrder < Struct.new( # # @!attribute [rw] instance_role # The Amazon ECS instance profile applied to Amazon EC2 instances in a - # compute environment. You can specify the short name or full Amazon + # compute environment. This parameter is required for Amazon EC2 + # instances types. You can specify the short name or full Amazon # Resource Name (ARN) of an instance profile. For example, ` # ecsInstanceRole ` or # `arn:aws:iam:::instance-profile/ecsInstanceRole `. @@ -785,13 +784,12 @@ class ComputeResource < Struct.new( # The maximum number of Amazon EC2 vCPUs that an environment can # reach. # - # With `BEST_FIT_PROGRESSIVE`, `SPOT_CAPACITY_OPTIMIZED`, and - # `SPOT_PRICE_CAPACITY_OPTIMIZED` allocation strategies using + # With `BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and + # `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using # On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot # Instances, Batch might need to exceed `maxvCpus` to meet your # capacity requirements. In this event, Batch never exceeds `maxvCpus` - # by more than a single instance. That is, no more than a single - # instance from among those specified in your compute environment. + # by more than a single instance. # # # @return [Integer] @@ -922,12 +920,12 @@ class ComputeResource < Struct.new( # This allocation strategy is only available for Spot Instance # compute resources. # - # With both `BEST_FIT_PROGRESSIVE`, `SPOT_CAPACITY_OPTIMIZED`, and - # `SPOT_PRICE_CAPACITY_OPTIMIZED` strategies using On-Demand or Spot - # Instances, and the `BEST_FIT` strategy using Spot Instances, Batch - # might need to exceed `maxvCpus` to meet your capacity requirements. - # In this event, Batch never exceeds `maxvCpus` by more than a single - # instance. + # With `BEST_FIT_PROGRESSIVE`,`SPOT_CAPACITY_OPTIMIZED` and + # `SPOT_PRICE_CAPACITY_OPTIMIZED` (recommended) strategies using + # On-Demand or Spot Instances, and the `BEST_FIT` strategy using Spot + # Instances, Batch might need to exceed `maxvCpus` to meet your + # capacity requirements. In this event, Batch never exceeds `maxvCpus` + # by more than a single instance. # # # @@ -996,9 +994,9 @@ class ComputeResource < Struct.new( # # @!attribute [rw] instance_role # The Amazon ECS instance profile applied to Amazon EC2 instances in a - # compute environment. You can specify the short name or full Amazon - # Resource Name (ARN) of an instance profile. For example, ` - # ecsInstanceRole ` or + # compute environment. Required for Amazon EC2 instances. You can + # specify the short name or full Amazon Resource Name (ARN) of an + # instance profile. For example, ` ecsInstanceRole ` or # `arn:aws:iam:::instance-profile/ecsInstanceRole `. # For more information, see [Amazon ECS instance role][1] in the # *Batch User Guide*. @@ -1508,6 +1506,10 @@ class ComputeResourceUpdate < Struct.new( # Batch jobs on Fargate. # @return [Types::RuntimePlatform] # + # @!attribute [rw] repository_credentials + # The private repository authentication credentials to use. + # @return [Types::RepositoryCredentials] + # # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerDetail AWS API Documentation # class ContainerDetail < Struct.new( @@ -1538,7 +1540,8 @@ class ContainerDetail < Struct.new( :network_configuration, :fargate_platform_configuration, :ephemeral_storage, - :runtime_platform) + :runtime_platform, + :repository_credentials) SENSITIVE = [] include Aws::Structure end @@ -1644,8 +1647,8 @@ class ContainerOverrides < Struct.new( # a job. # # @!attribute [rw] image - # The image used to start a container. This string is passed directly - # to the Docker daemon. Images in the Docker Hub registry are + # Required. The image used to start a container. This string is passed + # directly to the Docker daemon. Images in the Docker Hub registry are # available by default. Other repositories are specified with ` # repository-url/image:tag `. It can be 255 characters long. It can # contain uppercase and lowercase letters, numbers, hyphens (-), @@ -1947,6 +1950,10 @@ class ContainerOverrides < Struct.new( # Batch jobs on Fargate. # @return [Types::RuntimePlatform] # + # @!attribute [rw] repository_credentials + # The private repository authentication credentials to use. + # @return [Types::RepositoryCredentials] + # # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/ContainerProperties AWS API Documentation # class ContainerProperties < Struct.new( @@ -1971,7 +1978,8 @@ class ContainerProperties < Struct.new( :network_configuration, :fargate_platform_configuration, :ephemeral_storage, - :runtime_platform) + :runtime_platform, + :repository_credentials) SENSITIVE = [] include Aws::Structure end @@ -2464,7 +2472,8 @@ class DescribeComputeEnvironmentsResponse < Struct.new( # either be an ARN in the format # `arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}` # or a short version using the form - # `$\{JobDefinitionName\}:$\{Revision\}`. + # `$\{JobDefinitionName\}:$\{Revision\}`. This parameter can't be + # used with other parameters. # @return [Array] # # @!attribute [rw] max_results @@ -2829,16 +2838,24 @@ class EFSVolumeConfiguration < Struct.new( # (for example `P4` and `G4`) and can be used for all non Amazon # Web Services Graviton-based instance types. # + # ECS\_AL2023 + # + # : [Amazon Linux 2023][3]: Batch supports Amazon Linux 2023. + # + # Amazon Linux 2023 does not support `A1` instances. + # + # + # # ECS\_AL1 # - # : [Amazon Linux][3]. Amazon Linux has reached the end-of-life of + # : [Amazon Linux][4]. Amazon Linux has reached the end-of-life of # standard support. For more information, see [Amazon Linux - # AMI][4]. + # AMI][5]. # # EKS # # : If the `imageIdOverride` parameter isn't specified, then a recent - # [Amazon EKS-optimized Amazon Linux AMI][5] (`EKS_AL2`) is used. If + # [Amazon EKS-optimized Amazon Linux AMI][6] (`EKS_AL2`) is used. If # a new image type is specified in an update, but neither an # `imageId` nor a `imageIdOverride` parameter is specified, then the # latest Amazon EKS optimized AMI for that image type that Batch @@ -2846,11 +2863,11 @@ class EFSVolumeConfiguration < Struct.new( # # EKS\_AL2 # - # : [Amazon Linux 2][5]: Default for all non-GPU instance families. + # : [Amazon Linux 2][6]: Default for all non-GPU instance families. # # EKS\_AL2\_NVIDIA # - # : [Amazon Linux 2 (accelerated)][5]: Default for all GPU instance + # : [Amazon Linux 2 (accelerated)][6]: Default for all GPU instance # families (for example, `P4` and `G4`) and can be used for all # non Amazon Web Services Graviton-based instance types. # @@ -2858,9 +2875,10 @@ class EFSVolumeConfiguration < Struct.new( # # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami - # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami - # [4]: http://aws.amazon.com/amazon-linux-ami/ - # [5]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html + # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html + # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami + # [5]: http://aws.amazon.com/amazon-linux-ami/ + # [6]: https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html # @return [String] # # @!attribute [rw] image_id_override @@ -4066,9 +4084,9 @@ class EvaluateOnExit < Struct.new( # where ` ActiveFairShares ` is the number of active fair share # identifiers. # - # For example, a `computeReservation` value of 50 indicates that - # Batchreserves 50% of the maximum available vCPU if there's only one - # fair share identifier. It reserves 25% if there are two fair share + # For example, a `computeReservation` value of 50 indicates that Batch + # reserves 50% of the maximum available vCPU if there's only one fair + # share identifier. It reserves 25% if there are two fair share # identifiers. It reserves 12.5% if there are three fair share # identifiers. A `computeReservation` value of 25 indicates that Batch # should reserve 25% of the maximum available vCPU if there's only @@ -4369,8 +4387,7 @@ class JobDependency < Struct.new( # @!attribute [rw] started_at # The Unix timestamp (in milliseconds) for when the job was started. # More specifically, it's when the job transitioned from the - # `STARTING` state to the `RUNNING` state. This parameter isn't - # provided for child jobs of array jobs or multi-node parallel jobs. + # `STARTING` state to the `RUNNING` state. # @return [Integer] # # @!attribute [rw] stopped_at @@ -5272,7 +5289,7 @@ class LogConfiguration < Struct.new( # # # - # [1]: https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container + # [1]: https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate # # @!attribute [rw] container_path # The path on the container where the host volume is mounted. @@ -5706,6 +5723,21 @@ class RegisterJobDefinitionResponse < Struct.new( include Aws::Structure end + # The repository credentials for private registry authentication. + # + # @!attribute [rw] credentials_parameter + # The Amazon Resource Name (ARN) of the secret containing the private + # repository credentials. + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RepositoryCredentials AWS API Documentation + # + class RepositoryCredentials < Struct.new( + :credentials_parameter) + SENSITIVE = [] + include Aws::Structure + end + # The type and amount of a resource to assign to a container. The # supported resources include `GPU`, `MEMORY`, and `VCPU`. # @@ -5927,19 +5959,21 @@ class RetryStrategy < Struct.new( # # # - # The Batch Scheduler checks before registering a task definition with - # Fargate. If the job requires a Windows container and the first + # The Batch Scheduler checks the compute environments that are + # attached to the job queue before registering a task definition with + # Fargate. In this scenario, the job queue is where the job is + # submitted. If the job requires a Windows container and the first # compute environment is `LINUX`, the compute environment is skipped - # and the next is checked until a Windows-based compute environment is - # found. + # and the next compute environment is checked until a Windows-based + # compute environment is found. # # # - # Fargate Spot is not supported for Windows-based containers on - # Fargate. A job queue will be blocked if a Fargate Windows job is - # submitted to a job queue with only Fargate Spot compute - # environments. However, you can attach both `FARGATE` and - # `FARGATE_SPOT` compute environments to the same job queue. + # Fargate Spot is not supported for `ARM64` and Windows-based + # containers on Fargate. A job queue will be blocked if a Fargate + # `ARM64` or Windows job is submitted to a job queue with only Fargate + # Spot compute environments. However, you can attach both `FARGATE` + # and `FARGATE_SPOT` compute environments to the same job queue. # # # @return [String] @@ -5951,6 +5985,14 @@ class RetryStrategy < Struct.new( # This parameter must be set to `X86_64` for Windows containers. # # + # + # Fargate Spot is not supported for `ARM64` and Windows-based + # containers on Fargate. A job queue will be blocked if a Fargate + # `ARM64` or Windows job is submitted to a job queue with only Fargate + # Spot compute environments. However, you can attach both `FARGATE` + # and `FARGATE_SPOT` compute environments to the same job queue. + # + # # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10/RuntimePlatform AWS API Documentation @@ -6139,7 +6181,8 @@ class ShareAttributes < Struct.new( # The scheduling priority for the job. This only affects jobs in job # queues with a fair share policy. Jobs with a higher scheduling # priority are scheduled before jobs with a lower scheduling priority. - # This overrides any scheduling priority in the job definition. + # This overrides any scheduling priority in the job definition and + # works only within a single share identifier. # # The minimum supported value is 0 and the maximum supported value is # 9999. @@ -6402,19 +6445,27 @@ class Tmpfs < Struct.new( include Aws::Structure end - # The `ulimit` settings to pass to the container. + # The `ulimit` settings to pass to the container. For more information, + # see [Ulimit][1]. # # This object isn't applicable to jobs that are running on Fargate # resources. # # # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html + # # @!attribute [rw] hard_limit # The hard limit for the `ulimit` type. # @return [Integer] # # @!attribute [rw] name - # The `type` of the `ulimit`. + # The `type` of the `ulimit`. Valid values are: `core` \| `cpu` \| + # `data` \| `fsize` \| `locks` \| `memlock` \| `msgqueue` \| `nice` \| + # `nofile` \| `nproc` \| `rss` \| `rtprio` \| `rttime` \| `sigpending` + # \| `stack`. # @return [String] # # @!attribute [rw] soft_limit diff --git a/gems/aws-sdk-batch/sig/client.rbs b/gems/aws-sdk-batch/sig/client.rbs index 5e49cf22104..780419c4a99 100644 --- a/gems/aws-sdk-batch/sig/client.rbs +++ b/gems/aws-sdk-batch/sig/client.rbs @@ -430,6 +430,9 @@ module Aws runtime_platform: { operating_system_family: ::String?, cpu_architecture: ::String? + }?, + repository_credentials: { + credentials_parameter: ::String }? }, ?node_properties: { @@ -541,6 +544,9 @@ module Aws runtime_platform: { operating_system_family: ::String?, cpu_architecture: ::String? + }?, + repository_credentials: { + credentials_parameter: ::String }? }? }, diff --git a/gems/aws-sdk-batch/sig/types.rbs b/gems/aws-sdk-batch/sig/types.rbs index 073e2badb6c..2bbf42b1f45 100644 --- a/gems/aws-sdk-batch/sig/types.rbs +++ b/gems/aws-sdk-batch/sig/types.rbs @@ -154,6 +154,7 @@ module Aws::Batch attr_accessor fargate_platform_configuration: Types::FargatePlatformConfiguration attr_accessor ephemeral_storage: Types::EphemeralStorage attr_accessor runtime_platform: Types::RuntimePlatform + attr_accessor repository_credentials: Types::RepositoryCredentials SENSITIVE: [] end @@ -190,6 +191,7 @@ module Aws::Batch attr_accessor fargate_platform_configuration: Types::FargatePlatformConfiguration attr_accessor ephemeral_storage: Types::EphemeralStorage attr_accessor runtime_platform: Types::RuntimePlatform + attr_accessor repository_credentials: Types::RepositoryCredentials SENSITIVE: [] end @@ -805,6 +807,11 @@ module Aws::Batch SENSITIVE: [] end + class RepositoryCredentials + attr_accessor credentials_parameter: ::String + SENSITIVE: [] + end + class ResourceRequirement attr_accessor value: ::String attr_accessor type: ("GPU" | "VCPU" | "MEMORY") diff --git a/gems/aws-sdk-braket/CHANGELOG.md b/gems/aws-sdk-braket/CHANGELOG.md index 80dd57f77f5..5a7d0e25ca0 100644 --- a/gems/aws-sdk-braket/CHANGELOG.md +++ b/gems/aws-sdk-braket/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.34.0 (2024-02-09) +------------------ + +* Feature - Creating a job will result in DeviceOfflineException when using an offline device, and DeviceRetiredException when using a retired device. + 1.33.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-braket/VERSION b/gems/aws-sdk-braket/VERSION index 7aa332e4163..2b17ffd5042 100644 --- a/gems/aws-sdk-braket/VERSION +++ b/gems/aws-sdk-braket/VERSION @@ -1 +1 @@ -1.33.0 +1.34.0 diff --git a/gems/aws-sdk-braket/lib/aws-sdk-braket.rb b/gems/aws-sdk-braket/lib/aws-sdk-braket.rb index a513d0a7b58..b1076eb1f55 100644 --- a/gems/aws-sdk-braket/lib/aws-sdk-braket.rb +++ b/gems/aws-sdk-braket/lib/aws-sdk-braket.rb @@ -52,6 +52,6 @@ # @!group service module Aws::Braket - GEM_VERSION = '1.33.0' + GEM_VERSION = '1.34.0' end diff --git a/gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb b/gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb index 82b8153f2ee..7c157663018 100644 --- a/gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb +++ b/gems/aws-sdk-braket/lib/aws-sdk-braket/client.rb @@ -1150,7 +1150,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-braket' - context[:gem_version] = '1.33.0' + context[:gem_version] = '1.34.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-braket/lib/aws-sdk-braket/client_api.rb b/gems/aws-sdk-braket/lib/aws-sdk-braket/client_api.rb index 5a9a7b60b37..22203dbab1b 100644 --- a/gems/aws-sdk-braket/lib/aws-sdk-braket/client_api.rb +++ b/gems/aws-sdk-braket/lib/aws-sdk-braket/client_api.rb @@ -528,6 +528,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: ConflictException) o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) + o.errors << Shapes::ShapeRef.new(shape: DeviceOfflineException) o.errors << Shapes::ShapeRef.new(shape: DeviceRetiredException) o.errors << Shapes::ShapeRef.new(shape: InternalServiceException) o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException) diff --git a/gems/aws-sdk-costoptimizationhub/CHANGELOG.md b/gems/aws-sdk-costoptimizationhub/CHANGELOG.md index 2f4261467eb..4d4e293b950 100644 --- a/gems/aws-sdk-costoptimizationhub/CHANGELOG.md +++ b/gems/aws-sdk-costoptimizationhub/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.3.0 (2024-02-09) +------------------ + +* Feature - Adding includeMemberAccounts field to the response of ListEnrollmentStatuses API. + 1.2.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-costoptimizationhub/VERSION b/gems/aws-sdk-costoptimizationhub/VERSION index 26aaba0e866..f0bb29e7638 100644 --- a/gems/aws-sdk-costoptimizationhub/VERSION +++ b/gems/aws-sdk-costoptimizationhub/VERSION @@ -1 +1 @@ -1.2.0 +1.3.0 diff --git a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub.rb b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub.rb index d30cae1e7a3..e5543d396f4 100644 --- a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub.rb +++ b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub.rb @@ -52,6 +52,6 @@ # @!group service module Aws::CostOptimizationHub - GEM_VERSION = '1.2.0' + GEM_VERSION = '1.3.0' end diff --git a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client.rb b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client.rb index d178a764931..1383d192b80 100644 --- a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client.rb +++ b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client.rb @@ -888,7 +888,7 @@ def get_recommendation(params = {}, options = {}) # list of accounts that are enrolled under the organization. # # @option params [String] :account_id - # The enrollment status of a specific account ID in the organization. + # The account ID of a member account in the organization. # # @option params [Boolean] :include_organization_info # Indicates whether to return the enrollment status for the @@ -902,6 +902,7 @@ def get_recommendation(params = {}, options = {}) # # @return [Types::ListEnrollmentStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # + # * {Types::ListEnrollmentStatusesResponse#include_member_accounts #include_member_accounts} => Boolean # * {Types::ListEnrollmentStatusesResponse#items #items} => Array<Types::AccountEnrollmentStatus> # * {Types::ListEnrollmentStatusesResponse#next_token #next_token} => String # @@ -918,6 +919,7 @@ def get_recommendation(params = {}, options = {}) # # @example Response structure # + # resp.include_member_accounts #=> Boolean # resp.items #=> Array # resp.items[0].account_id #=> String # resp.items[0].created_timestamp #=> Time @@ -1197,7 +1199,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-costoptimizationhub' - context[:gem_version] = '1.2.0' + context[:gem_version] = '1.3.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client_api.rb b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client_api.rb index cb29ed34b71..45ccae7c830 100644 --- a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client_api.rb +++ b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/client_api.rb @@ -304,6 +304,7 @@ module ClientApi ListEnrollmentStatusesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken")) ListEnrollmentStatusesRequest.struct_class = Types::ListEnrollmentStatusesRequest + ListEnrollmentStatusesResponse.add_member(:include_member_accounts, Shapes::ShapeRef.new(shape: Boolean, location_name: "includeMemberAccounts")) ListEnrollmentStatusesResponse.add_member(:items, Shapes::ShapeRef.new(shape: AccountEnrollmentStatuses, location_name: "items")) ListEnrollmentStatusesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: String, location_name: "nextToken")) ListEnrollmentStatusesResponse.struct_class = Types::ListEnrollmentStatusesResponse diff --git a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/types.rb b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/types.rb index a1a3e2efbc1..e9ffa75dcdb 100644 --- a/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/types.rb +++ b/gems/aws-sdk-costoptimizationhub/lib/aws-sdk-costoptimizationhub/types.rb @@ -894,7 +894,7 @@ class LambdaFunctionConfiguration < Struct.new( end # @!attribute [rw] account_id - # The enrollment status of a specific account ID in the organization. + # The account ID of a member account in the organization. # @return [String] # # @!attribute [rw] include_organization_info @@ -921,8 +921,14 @@ class ListEnrollmentStatusesRequest < Struct.new( include Aws::Structure end + # @!attribute [rw] include_member_accounts + # The enrollment status of all member accounts in the organization if + # the account is the management account. + # @return [Boolean] + # # @!attribute [rw] items - # The account enrollment statuses. + # The enrollment status of a specific account ID, including creation + # and last updated timestamps. # @return [Array] # # @!attribute [rw] next_token @@ -932,6 +938,7 @@ class ListEnrollmentStatusesRequest < Struct.new( # @see http://docs.aws.amazon.com/goto/WebAPI/cost-optimization-hub-2022-07-26/ListEnrollmentStatusesResponse AWS API Documentation # class ListEnrollmentStatusesResponse < Struct.new( + :include_member_accounts, :items, :next_token) SENSITIVE = [] diff --git a/gems/aws-sdk-costoptimizationhub/sig/client.rbs b/gems/aws-sdk-costoptimizationhub/sig/client.rbs index 661f273a2fe..76c85292cc3 100644 --- a/gems/aws-sdk-costoptimizationhub/sig/client.rbs +++ b/gems/aws-sdk-costoptimizationhub/sig/client.rbs @@ -117,6 +117,7 @@ module Aws interface _ListEnrollmentStatusesResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListEnrollmentStatusesResponse] + def include_member_accounts: () -> bool def items: () -> ::Array[Types::AccountEnrollmentStatus] def next_token: () -> ::String end diff --git a/gems/aws-sdk-costoptimizationhub/sig/types.rbs b/gems/aws-sdk-costoptimizationhub/sig/types.rbs index 58c9b3dbd9e..85ed10a8b2d 100644 --- a/gems/aws-sdk-costoptimizationhub/sig/types.rbs +++ b/gems/aws-sdk-costoptimizationhub/sig/types.rbs @@ -253,6 +253,7 @@ module Aws::CostOptimizationHub end class ListEnrollmentStatusesResponse + attr_accessor include_member_accounts: bool attr_accessor items: ::Array[Types::AccountEnrollmentStatus] attr_accessor next_token: ::String SENSITIVE: [] diff --git a/gems/aws-sdk-ecs/CHANGELOG.md b/gems/aws-sdk-ecs/CHANGELOG.md index df85eeefe91..df0d2c8fe3b 100644 --- a/gems/aws-sdk-ecs/CHANGELOG.md +++ b/gems/aws-sdk-ecs/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.142.0 (2024-02-09) +------------------ + +* Feature - Documentation only update for Amazon ECS. + 1.141.0 (2024-02-06) ------------------ diff --git a/gems/aws-sdk-ecs/VERSION b/gems/aws-sdk-ecs/VERSION index 642c6da52ce..246c5532a6a 100644 --- a/gems/aws-sdk-ecs/VERSION +++ b/gems/aws-sdk-ecs/VERSION @@ -1 +1 @@ -1.141.0 +1.142.0 diff --git a/gems/aws-sdk-ecs/lib/aws-sdk-ecs.rb b/gems/aws-sdk-ecs/lib/aws-sdk-ecs.rb index 26da1cfd5e0..3dc252daa1c 100644 --- a/gems/aws-sdk-ecs/lib/aws-sdk-ecs.rb +++ b/gems/aws-sdk-ecs/lib/aws-sdk-ecs.rb @@ -53,6 +53,6 @@ # @!group service module Aws::ECS - GEM_VERSION = '1.141.0' + GEM_VERSION = '1.142.0' end diff --git a/gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb b/gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb index d75b0098c68..d799a6d22d2 100644 --- a/gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb +++ b/gems/aws-sdk-ecs/lib/aws-sdk-ecs/client.rb @@ -5588,93 +5588,103 @@ def list_tasks(params = {}, options = {}) # account settings. For more information, see [Account Settings][1] in # the *Amazon Elastic Container Service Developer Guide*. # - # When you specify `serviceLongArnFormat`, `taskLongArnFormat`, or - # `containerInstanceLongArnFormat`, the Amazon Resource Name (ARN) and - # resource ID format of the resource type for a specified user, role, or - # the root user for an account is affected. The opt-in and opt-out - # account setting must be set for each Amazon ECS resource separately. - # The ARN and resource ID format of a resource is defined by the opt-in - # status of the user or role that created the resource. You must turn on - # this setting to use Amazon ECS features such as resource tagging. - # - # When you specify `awsvpcTrunking`, the elastic network interface (ENI) - # limit for any new container instances that support the feature is - # changed. If `awsvpcTrunking` is turned on, any new container instances - # that support the feature are launched have the increased ENI limits - # available to them. For more information, see [Elastic Network - # Interface Trunking][2] in the *Amazon Elastic Container Service - # Developer Guide*. - # - # When you specify `containerInsights`, the default setting indicating - # whether Amazon Web Services CloudWatch Container Insights is turned on - # for your clusters is changed. If `containerInsights` is turned on, any - # new clusters that are created will have Container Insights turned on - # unless you disable it during cluster creation. For more information, - # see [CloudWatch Container Insights][3] in the *Amazon Elastic - # Container Service Developer Guide*. - # - # Amazon ECS is introducing tagging authorization for resource creation. - # Users must have permissions for actions that create the resource, such - # as `ecsCreateCluster`. If tags are specified when you create a - # resource, Amazon Web Services performs additional authorization to - # verify if users or roles have permissions to create tags. Therefore, - # you must grant explicit permissions to use the `ecs:TagResource` - # action. For more information, see [Grant permission to tag resources - # on creation][4] in the *Amazon ECS Developer Guide*. - # - # When Amazon Web Services determines that a security or infrastructure - # update is needed for an Amazon ECS task hosted on Fargate, the tasks - # need to be stopped and new tasks launched to replace them. Use - # `fargateTaskRetirementWaitPeriod` to configure the wait time to retire - # a Fargate task. For information about the Fargate tasks maintenance, - # see [Amazon Web Services Fargate task maintenance][5] in the *Amazon - # ECS Developer Guide*. - # - # The `guardDutyActivate` parameter is read-only in Amazon ECS and - # indicates whether Amazon ECS Runtime Monitoring is enabled or disabled - # by your security administrator in your Amazon ECS account. Amazon - # GuardDuty controls this account setting on your behalf. For more - # information, see [Protecting Amazon ECS workloads with Amazon ECS - # Runtime Monitoring][6]. - # # # # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html - # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html - # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html - # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html - # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html - # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html # # @option params [required, String] :name - # The Amazon ECS resource name for which to modify the account setting. - # If you specify `serviceLongArnFormat`, the ARN for your Amazon ECS - # services is affected. If you specify `taskLongArnFormat`, the ARN and - # resource ID for your Amazon ECS tasks is affected. If you specify - # `containerInstanceLongArnFormat`, the ARN and resource ID for your - # Amazon ECS container instances is affected. If you specify - # `awsvpcTrunking`, the elastic network interface (ENI) limit for your - # Amazon ECS container instances is affected. If you specify - # `containerInsights`, the default setting for Amazon Web Services - # CloudWatch Container Insights for your clusters is affected. If you - # specify `fargateFIPSMode`, Fargate FIPS 140 compliance is affected. If - # you specify `tagResourceAuthorization`, the opt-in option for tagging - # resources on creation is affected. For information about the opt-in - # timeline, see [Tagging authorization timeline][1] in the *Amazon ECS - # Developer Guide*. If you specify `fargateTaskRetirementWaitPeriod`, - # the wait time to retire a Fargate task is affected. - # - # The `guardDutyActivate` parameter is read-only in Amazon ECS and - # indicates whether Amazon ECS Runtime Monitoring is enabled or disabled - # by your security administrator in your Amazon ECS account. Amazon - # GuardDuty controls this account setting on your behalf. For more - # information, see [Protecting Amazon ECS workloads with Amazon ECS - # Runtime Monitoring][2]. - # - # - # - # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources - # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + # The Amazon ECS account setting name to modify. + # + # The following are the valid values for the account setting name. + # + # * `serviceLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The opt-in + # and opt-out account setting must be set for each Amazon ECS resource + # separately. The ARN and resource ID format of a resource is defined + # by the opt-in status of the user or role that created the resource. + # You must turn on this setting to use Amazon ECS features such as + # resource tagging. + # + # * `taskLongArnFormat` - When modified, the Amazon Resource Name (ARN) + # and resource ID format of the resource type for a specified user, + # role, or the root user for an account is affected. The opt-in and + # opt-out account setting must be set for each Amazon ECS resource + # separately. The ARN and resource ID format of a resource is defined + # by the opt-in status of the user or role that created the resource. + # You must turn on this setting to use Amazon ECS features such as + # resource tagging. + # + # * `containerInstanceLongArnFormat` - When modified, the Amazon + # Resource Name (ARN) and resource ID format of the resource type for + # a specified user, role, or the root user for an account is affected. + # The opt-in and opt-out account setting must be set for each Amazon + # ECS resource separately. The ARN and resource ID format of a + # resource is defined by the opt-in status of the user or role that + # created the resource. You must turn on this setting to use Amazon + # ECS features such as resource tagging. + # + # * `awsvpcTrunking` - When modified, the elastic network interface + # (ENI) limit for any new container instances that support the feature + # is changed. If `awsvpcTrunking` is turned on, any new container + # instances that support the feature are launched have the increased + # ENI limits available to them. For more information, see [Elastic + # Network Interface Trunking][1] in the *Amazon Elastic Container + # Service Developer Guide*. + # + # * `containerInsights` - When modified, the default setting indicating + # whether Amazon Web Services CloudWatch Container Insights is turned + # on for your clusters is changed. If `containerInsights` is turned + # on, any new clusters that are created will have Container Insights + # turned on unless you disable it during cluster creation. For more + # information, see [CloudWatch Container Insights][2] in the *Amazon + # Elastic Container Service Developer Guide*. + # + # * `dualStackIPv6` - When turned on, when using a VPC in dual stack + # mode, your tasks using the `awsvpc` network mode can have an IPv6 + # address assigned. For more information on using IPv6 with tasks + # launched on Amazon EC2 instances, see [Using a VPC in dual-stack + # mode][3]. For more information on using IPv6 with tasks launched on + # Fargate, see [Using a VPC in dual-stack mode][4]. + # + # * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS + # 140 compliance is affected. + # + # * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services + # determines that a security or infrastructure update is needed for an + # Amazon ECS task hosted on Fargate, the tasks need to be stopped and + # new tasks launched to replace them. Use + # `fargateTaskRetirementWaitPeriod` to configure the wait time to + # retire a Fargate task. For information about the Fargate tasks + # maintenance, see [Amazon Web Services Fargate task maintenance][5] + # in the *Amazon ECS Developer Guide*. + # + # * `tagResourceAuthorization` - Amazon ECS is introducing tagging + # authorization for resource creation. Users must have permissions for + # actions that create the resource, such as `ecsCreateCluster`. If + # tags are specified when you create a resource, Amazon Web Services + # performs additional authorization to verify if users or roles have + # permissions to create tags. Therefore, you must grant explicit + # permissions to use the `ecs:TagResource` action. For more + # information, see [Grant permission to tag resources on creation][6] + # in the *Amazon ECS Developer Guide*. + # + # * `guardDutyActivate` - The `guardDutyActivate` parameter is read-only + # in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is + # enabled or disabled by your security administrator in your Amazon + # ECS account. Amazon GuardDuty controls this account setting on your + # behalf. For more information, see [Protecting Amazon ECS workloads + # with Amazon ECS Runtime Monitoring][7]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html + # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack + # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + # [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html # # @option params [required, String] :value # The account setting value for the specified principal ARN. Accepted @@ -5782,50 +5792,98 @@ def put_account_setting(params = {}, options = {}) # set on a per-Region basis. # # @option params [required, String] :name - # The resource name for which to modify the account setting. If you - # specify `serviceLongArnFormat`, the ARN for your Amazon ECS services - # is affected. If you specify `taskLongArnFormat`, the ARN and resource - # ID for your Amazon ECS tasks is affected. If you specify - # `containerInstanceLongArnFormat`, the ARN and resource ID for your - # Amazon ECS container instances is affected. If you specify - # `awsvpcTrunking`, the ENI limit for your Amazon ECS container - # instances is affected. If you specify `containerInsights`, the default - # setting for Amazon Web Services CloudWatch Container Insights for your - # clusters is affected. If you specify `tagResourceAuthorization`, the - # opt-in option for tagging resources on creation is affected. For - # information about the opt-in timeline, see [Tagging authorization - # timeline][1] in the *Amazon ECS Developer Guide*. If you specify - # `fargateTaskRetirementWaitPeriod`, the default wait time to retire a - # Fargate task due to required maintenance is affected. - # - # When you specify `fargateFIPSMode` for the `name` and `enabled` for - # the `value`, Fargate uses FIPS-140 compliant cryptographic algorithms - # on your tasks. For more information about FIPS-140 compliance with - # Fargate, see [ Amazon Web Services Fargate Federal Information - # Processing Standard (FIPS) 140-2 compliance][2] in the *Amazon Elastic - # Container Service Developer Guide*. - # - # When Amazon Web Services determines that a security or infrastructure - # update is needed for an Amazon ECS task hosted on Fargate, the tasks - # need to be stopped and new tasks launched to replace them. Use - # `fargateTaskRetirementWaitPeriod` to set the wait time to retire a - # Fargate task to the default. For information about the Fargate tasks - # maintenance, see [Amazon Web Services Fargate task maintenance][3] in - # the *Amazon ECS Developer Guide*. - # - # The `guardDutyActivate` parameter is read-only in Amazon ECS and - # indicates whether Amazon ECS Runtime Monitoring is enabled or disabled - # by your security administrator in your Amazon ECS account. Amazon - # GuardDuty controls this account setting on your behalf. For more - # information, see [Protecting Amazon ECS workloads with Amazon ECS - # Runtime Monitoring][4]. - # - # - # - # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources - # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html - # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html - # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + # The resource name for which to modify the account setting. + # + # The following are the valid values for the account setting name. + # + # * `serviceLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The opt-in + # and opt-out account setting must be set for each Amazon ECS resource + # separately. The ARN and resource ID format of a resource is defined + # by the opt-in status of the user or role that created the resource. + # You must turn on this setting to use Amazon ECS features such as + # resource tagging. + # + # * `taskLongArnFormat` - When modified, the Amazon Resource Name (ARN) + # and resource ID format of the resource type for a specified user, + # role, or the root user for an account is affected. The opt-in and + # opt-out account setting must be set for each Amazon ECS resource + # separately. The ARN and resource ID format of a resource is defined + # by the opt-in status of the user or role that created the resource. + # You must turn on this setting to use Amazon ECS features such as + # resource tagging. + # + # * `containerInstanceLongArnFormat` - When modified, the Amazon + # Resource Name (ARN) and resource ID format of the resource type for + # a specified user, role, or the root user for an account is affected. + # The opt-in and opt-out account setting must be set for each Amazon + # ECS resource separately. The ARN and resource ID format of a + # resource is defined by the opt-in status of the user or role that + # created the resource. You must turn on this setting to use Amazon + # ECS features such as resource tagging. + # + # * `awsvpcTrunking` - When modified, the elastic network interface + # (ENI) limit for any new container instances that support the feature + # is changed. If `awsvpcTrunking` is turned on, any new container + # instances that support the feature are launched have the increased + # ENI limits available to them. For more information, see [Elastic + # Network Interface Trunking][1] in the *Amazon Elastic Container + # Service Developer Guide*. + # + # * `containerInsights` - When modified, the default setting indicating + # whether Amazon Web Services CloudWatch Container Insights is turned + # on for your clusters is changed. If `containerInsights` is turned + # on, any new clusters that are created will have Container Insights + # turned on unless you disable it during cluster creation. For more + # information, see [CloudWatch Container Insights][2] in the *Amazon + # Elastic Container Service Developer Guide*. + # + # * `dualStackIPv6` - When turned on, when using a VPC in dual stack + # mode, your tasks using the `awsvpc` network mode can have an IPv6 + # address assigned. For more information on using IPv6 with tasks + # launched on Amazon EC2 instances, see [Using a VPC in dual-stack + # mode][3]. For more information on using IPv6 with tasks launched on + # Fargate, see [Using a VPC in dual-stack mode][4]. + # + # * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS + # 140 compliance is affected. + # + # * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services + # determines that a security or infrastructure update is needed for an + # Amazon ECS task hosted on Fargate, the tasks need to be stopped and + # new tasks launched to replace them. Use + # `fargateTaskRetirementWaitPeriod` to configure the wait time to + # retire a Fargate task. For information about the Fargate tasks + # maintenance, see [Amazon Web Services Fargate task maintenance][5] + # in the *Amazon ECS Developer Guide*. + # + # * `tagResourceAuthorization` - Amazon ECS is introducing tagging + # authorization for resource creation. Users must have permissions for + # actions that create the resource, such as `ecsCreateCluster`. If + # tags are specified when you create a resource, Amazon Web Services + # performs additional authorization to verify if users or roles have + # permissions to create tags. Therefore, you must grant explicit + # permissions to use the `ecs:TagResource` action. For more + # information, see [Grant permission to tag resources on creation][6] + # in the *Amazon ECS Developer Guide*. + # + # * `guardDutyActivate` - The `guardDutyActivate` parameter is read-only + # in Amazon ECS and indicates whether Amazon ECS Runtime Monitoring is + # enabled or disabled by your security administrator in your Amazon + # ECS account. Amazon GuardDuty controls this account setting on your + # behalf. For more information, see [Protecting Amazon ECS workloads + # with Amazon ECS Runtime Monitoring][7]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html + # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack + # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + # [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html # # @option params [required, String] :value # The account setting value for the specified principal ARN. Accepted @@ -10167,7 +10225,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-ecs' - context[:gem_version] = '1.141.0' + context[:gem_version] = '1.142.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb b/gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb index 1999102357b..d34982cd5b4 100644 --- a/gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb +++ b/gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb @@ -7377,51 +7377,99 @@ class ProxyConfiguration < Struct.new( end # @!attribute [rw] name - # The resource name for which to modify the account setting. If you - # specify `serviceLongArnFormat`, the ARN for your Amazon ECS services - # is affected. If you specify `taskLongArnFormat`, the ARN and - # resource ID for your Amazon ECS tasks is affected. If you specify - # `containerInstanceLongArnFormat`, the ARN and resource ID for your - # Amazon ECS container instances is affected. If you specify - # `awsvpcTrunking`, the ENI limit for your Amazon ECS container - # instances is affected. If you specify `containerInsights`, the - # default setting for Amazon Web Services CloudWatch Container - # Insights for your clusters is affected. If you specify - # `tagResourceAuthorization`, the opt-in option for tagging resources - # on creation is affected. For information about the opt-in timeline, - # see [Tagging authorization timeline][1] in the *Amazon ECS Developer - # Guide*. If you specify `fargateTaskRetirementWaitPeriod`, the - # default wait time to retire a Fargate task due to required - # maintenance is affected. - # - # When you specify `fargateFIPSMode` for the `name` and `enabled` for - # the `value`, Fargate uses FIPS-140 compliant cryptographic - # algorithms on your tasks. For more information about FIPS-140 - # compliance with Fargate, see [ Amazon Web Services Fargate Federal - # Information Processing Standard (FIPS) 140-2 compliance][2] in the - # *Amazon Elastic Container Service Developer Guide*. - # - # When Amazon Web Services determines that a security or - # infrastructure update is needed for an Amazon ECS task hosted on - # Fargate, the tasks need to be stopped and new tasks launched to - # replace them. Use `fargateTaskRetirementWaitPeriod` to set the wait - # time to retire a Fargate task to the default. For information about - # the Fargate tasks maintenance, see [Amazon Web Services Fargate task - # maintenance][3] in the *Amazon ECS Developer Guide*. - # - # The `guardDutyActivate` parameter is read-only in Amazon ECS and - # indicates whether Amazon ECS Runtime Monitoring is enabled or - # disabled by your security administrator in your Amazon ECS account. - # Amazon GuardDuty controls this account setting on your behalf. For - # more information, see [Protecting Amazon ECS workloads with Amazon - # ECS Runtime Monitoring][4]. - # - # + # The resource name for which to modify the account setting. + # + # The following are the valid values for the account setting name. + # + # * `serviceLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The + # opt-in and opt-out account setting must be set for each Amazon ECS + # resource separately. The ARN and resource ID format of a resource + # is defined by the opt-in status of the user or role that created + # the resource. You must turn on this setting to use Amazon ECS + # features such as resource tagging. + # + # * `taskLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The + # opt-in and opt-out account setting must be set for each Amazon ECS + # resource separately. The ARN and resource ID format of a resource + # is defined by the opt-in status of the user or role that created + # the resource. You must turn on this setting to use Amazon ECS + # features such as resource tagging. + # + # * `containerInstanceLongArnFormat` - When modified, the Amazon + # Resource Name (ARN) and resource ID format of the resource type + # for a specified user, role, or the root user for an account is + # affected. The opt-in and opt-out account setting must be set for + # each Amazon ECS resource separately. The ARN and resource ID + # format of a resource is defined by the opt-in status of the user + # or role that created the resource. You must turn on this setting + # to use Amazon ECS features such as resource tagging. + # + # * `awsvpcTrunking` - When modified, the elastic network interface + # (ENI) limit for any new container instances that support the + # feature is changed. If `awsvpcTrunking` is turned on, any new + # container instances that support the feature are launched have the + # increased ENI limits available to them. For more information, see + # [Elastic Network Interface Trunking][1] in the *Amazon Elastic + # Container Service Developer Guide*. + # + # * `containerInsights` - When modified, the default setting + # indicating whether Amazon Web Services CloudWatch Container + # Insights is turned on for your clusters is changed. If + # `containerInsights` is turned on, any new clusters that are + # created will have Container Insights turned on unless you disable + # it during cluster creation. For more information, see [CloudWatch + # Container Insights][2] in the *Amazon Elastic Container Service + # Developer Guide*. # - # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources - # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html - # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html - # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + # * `dualStackIPv6` - When turned on, when using a VPC in dual stack + # mode, your tasks using the `awsvpc` network mode can have an IPv6 + # address assigned. For more information on using IPv6 with tasks + # launched on Amazon EC2 instances, see [Using a VPC in dual-stack + # mode][3]. For more information on using IPv6 with tasks launched + # on Fargate, see [Using a VPC in dual-stack mode][4]. + # + # * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS + # 140 compliance is affected. + # + # * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services + # determines that a security or infrastructure update is needed for + # an Amazon ECS task hosted on Fargate, the tasks need to be stopped + # and new tasks launched to replace them. Use + # `fargateTaskRetirementWaitPeriod` to configure the wait time to + # retire a Fargate task. For information about the Fargate tasks + # maintenance, see [Amazon Web Services Fargate task maintenance][5] + # in the *Amazon ECS Developer Guide*. + # + # * `tagResourceAuthorization` - Amazon ECS is introducing tagging + # authorization for resource creation. Users must have permissions + # for actions that create the resource, such as `ecsCreateCluster`. + # If tags are specified when you create a resource, Amazon Web + # Services performs additional authorization to verify if users or + # roles have permissions to create tags. Therefore, you must grant + # explicit permissions to use the `ecs:TagResource` action. For more + # information, see [Grant permission to tag resources on + # creation][6] in the *Amazon ECS Developer Guide*. + # + # * `guardDutyActivate` - The `guardDutyActivate` parameter is + # read-only in Amazon ECS and indicates whether Amazon ECS Runtime + # Monitoring is enabled or disabled by your security administrator + # in your Amazon ECS account. Amazon GuardDuty controls this account + # setting on your behalf. For more information, see [Protecting + # Amazon ECS workloads with Amazon ECS Runtime Monitoring][7]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html + # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack + # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + # [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html # @return [String] # # @!attribute [rw] value @@ -7463,35 +7511,99 @@ class PutAccountSettingDefaultResponse < Struct.new( end # @!attribute [rw] name - # The Amazon ECS resource name for which to modify the account - # setting. If you specify `serviceLongArnFormat`, the ARN for your - # Amazon ECS services is affected. If you specify `taskLongArnFormat`, - # the ARN and resource ID for your Amazon ECS tasks is affected. If - # you specify `containerInstanceLongArnFormat`, the ARN and resource - # ID for your Amazon ECS container instances is affected. If you - # specify `awsvpcTrunking`, the elastic network interface (ENI) limit - # for your Amazon ECS container instances is affected. If you specify - # `containerInsights`, the default setting for Amazon Web Services - # CloudWatch Container Insights for your clusters is affected. If you - # specify `fargateFIPSMode`, Fargate FIPS 140 compliance is affected. - # If you specify `tagResourceAuthorization`, the opt-in option for - # tagging resources on creation is affected. For information about the - # opt-in timeline, see [Tagging authorization timeline][1] in the - # *Amazon ECS Developer Guide*. If you specify - # `fargateTaskRetirementWaitPeriod`, the wait time to retire a Fargate - # task is affected. - # - # The `guardDutyActivate` parameter is read-only in Amazon ECS and - # indicates whether Amazon ECS Runtime Monitoring is enabled or - # disabled by your security administrator in your Amazon ECS account. - # Amazon GuardDuty controls this account setting on your behalf. For - # more information, see [Protecting Amazon ECS workloads with Amazon - # ECS Runtime Monitoring][2]. - # - # - # - # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources - # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html + # The Amazon ECS account setting name to modify. + # + # The following are the valid values for the account setting name. + # + # * `serviceLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The + # opt-in and opt-out account setting must be set for each Amazon ECS + # resource separately. The ARN and resource ID format of a resource + # is defined by the opt-in status of the user or role that created + # the resource. You must turn on this setting to use Amazon ECS + # features such as resource tagging. + # + # * `taskLongArnFormat` - When modified, the Amazon Resource Name + # (ARN) and resource ID format of the resource type for a specified + # user, role, or the root user for an account is affected. The + # opt-in and opt-out account setting must be set for each Amazon ECS + # resource separately. The ARN and resource ID format of a resource + # is defined by the opt-in status of the user or role that created + # the resource. You must turn on this setting to use Amazon ECS + # features such as resource tagging. + # + # * `containerInstanceLongArnFormat` - When modified, the Amazon + # Resource Name (ARN) and resource ID format of the resource type + # for a specified user, role, or the root user for an account is + # affected. The opt-in and opt-out account setting must be set for + # each Amazon ECS resource separately. The ARN and resource ID + # format of a resource is defined by the opt-in status of the user + # or role that created the resource. You must turn on this setting + # to use Amazon ECS features such as resource tagging. + # + # * `awsvpcTrunking` - When modified, the elastic network interface + # (ENI) limit for any new container instances that support the + # feature is changed. If `awsvpcTrunking` is turned on, any new + # container instances that support the feature are launched have the + # increased ENI limits available to them. For more information, see + # [Elastic Network Interface Trunking][1] in the *Amazon Elastic + # Container Service Developer Guide*. + # + # * `containerInsights` - When modified, the default setting + # indicating whether Amazon Web Services CloudWatch Container + # Insights is turned on for your clusters is changed. If + # `containerInsights` is turned on, any new clusters that are + # created will have Container Insights turned on unless you disable + # it during cluster creation. For more information, see [CloudWatch + # Container Insights][2] in the *Amazon Elastic Container Service + # Developer Guide*. + # + # * `dualStackIPv6` - When turned on, when using a VPC in dual stack + # mode, your tasks using the `awsvpc` network mode can have an IPv6 + # address assigned. For more information on using IPv6 with tasks + # launched on Amazon EC2 instances, see [Using a VPC in dual-stack + # mode][3]. For more information on using IPv6 with tasks launched + # on Fargate, see [Using a VPC in dual-stack mode][4]. + # + # * `fargateFIPSMode` - If you specify `fargateFIPSMode`, Fargate FIPS + # 140 compliance is affected. + # + # * `fargateTaskRetirementWaitPeriod` - When Amazon Web Services + # determines that a security or infrastructure update is needed for + # an Amazon ECS task hosted on Fargate, the tasks need to be stopped + # and new tasks launched to replace them. Use + # `fargateTaskRetirementWaitPeriod` to configure the wait time to + # retire a Fargate task. For information about the Fargate tasks + # maintenance, see [Amazon Web Services Fargate task maintenance][5] + # in the *Amazon ECS Developer Guide*. + # + # * `tagResourceAuthorization` - Amazon ECS is introducing tagging + # authorization for resource creation. Users must have permissions + # for actions that create the resource, such as `ecsCreateCluster`. + # If tags are specified when you create a resource, Amazon Web + # Services performs additional authorization to verify if users or + # roles have permissions to create tags. Therefore, you must grant + # explicit permissions to use the `ecs:TagResource` action. For more + # information, see [Grant permission to tag resources on + # creation][6] in the *Amazon ECS Developer Guide*. + # + # * `guardDutyActivate` - The `guardDutyActivate` parameter is + # read-only in Amazon ECS and indicates whether Amazon ECS Runtime + # Monitoring is enabled or disabled by your security administrator + # in your Amazon ECS account. Amazon GuardDuty controls this account + # setting on your behalf. For more information, see [Protecting + # Amazon ECS workloads with Amazon ECS Runtime Monitoring][7]. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html + # [3]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack + # [4]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack + # [5]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html + # [6]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html + # [7]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html # @return [String] # # @!attribute [rw] value @@ -8566,6 +8678,15 @@ class RunTaskRequest < Struct.new( # # @!attribute [rw] failures # Any failures associated with the call. + # + # For information about how to address failures, see [Service event + # messages][1] and [API failure reasons][2] in the *Amazon Elastic + # Container Service Developer Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list + # [2]: https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTaskResponse AWS API Documentation diff --git a/gems/aws-sdk-iot/CHANGELOG.md b/gems/aws-sdk-iot/CHANGELOG.md index 7b3494a2087..8f9d4884946 100644 --- a/gems/aws-sdk-iot/CHANGELOG.md +++ b/gems/aws-sdk-iot/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.120.0 (2024-02-09) +------------------ + +* Feature - This release allows AWS IoT Core users to enable Online Certificate Status Protocol (OCSP) Stapling for TLS X.509 Server Certificates when creating and updating AWS IoT Domain Configurations with Custom Domain. + 1.119.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-iot/VERSION b/gems/aws-sdk-iot/VERSION index 46cd9694132..499526a0114 100644 --- a/gems/aws-sdk-iot/VERSION +++ b/gems/aws-sdk-iot/VERSION @@ -1 +1 @@ -1.119.0 +1.120.0 diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot.rb index 64217e1e425..74789642c1f 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot.rb @@ -52,6 +52,6 @@ # @!group service module Aws::IoT - GEM_VERSION = '1.119.0' + GEM_VERSION = '1.120.0' end diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb index c6714d88503..5656cf0d8f5 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/client.rb @@ -1581,6 +1581,9 @@ def create_dimension(params = {}, options = {}) # @option params [Types::TlsConfig] :tls_config # An object that specifies the TLS configuration for a domain. # + # @option params [Types::ServerCertificateConfig] :server_certificate_config + # The server certificate configuration. + # # @return [Types::CreateDomainConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDomainConfigurationResponse#domain_configuration_name #domain_configuration_name} => String @@ -1607,6 +1610,9 @@ def create_dimension(params = {}, options = {}) # tls_config: { # security_policy: "SecurityPolicy", # }, + # server_certificate_config: { + # enable_ocsp_check: false, + # }, # }) # # @example Response structure @@ -5848,6 +5854,7 @@ def describe_dimension(params = {}, options = {}) # * {Types::DescribeDomainConfigurationResponse#domain_type #domain_type} => String # * {Types::DescribeDomainConfigurationResponse#last_status_change_date #last_status_change_date} => Time # * {Types::DescribeDomainConfigurationResponse#tls_config #tls_config} => Types::TlsConfig + # * {Types::DescribeDomainConfigurationResponse#server_certificate_config #server_certificate_config} => Types::ServerCertificateConfig # # @example Request syntax with placeholder values # @@ -5871,6 +5878,7 @@ def describe_dimension(params = {}, options = {}) # resp.domain_type #=> String, one of "ENDPOINT", "AWS_MANAGED", "CUSTOMER_MANAGED" # resp.last_status_change_date #=> Time # resp.tls_config.security_policy #=> String + # resp.server_certificate_config.enable_ocsp_check #=> Boolean # # @overload describe_domain_configuration(params = {}) # @param [Hash] params ({}) @@ -5879,8 +5887,13 @@ def describe_domain_configuration(params = {}, options = {}) req.send_request(options) end - # Returns a unique endpoint specific to the Amazon Web Services account - # making the call. + # Returns or creates a unique endpoint specific to the Amazon Web + # Services account making the call. + # + # The first time `DescribeEndpoint` is called, an endpoint is created. + # All subsequent calls to `DescribeEndpoint` return the same endpoint. + # + # # # Requires permission to access the [DescribeEndpoint][1] action. # @@ -7734,6 +7747,11 @@ def get_policy_version(params = {}, options = {}) # Gets a registration code used to register a CA certificate with IoT. # + # IoT will create a registration code as part of this API call if the + # registration code doesn't exist or has been deleted. If you already + # have a registration code, this API call will return the same + # registration code. + # # Requires permission to access the [GetRegistrationCode][1] action. # # @@ -13759,6 +13777,9 @@ def update_dimension(params = {}, options = {}) # @option params [Types::TlsConfig] :tls_config # An object that specifies the TLS configuration for a domain. # + # @option params [Types::ServerCertificateConfig] :server_certificate_config + # The server certificate configuration. + # # @return [Types::UpdateDomainConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDomainConfigurationResponse#domain_configuration_name #domain_configuration_name} => String @@ -13777,6 +13798,9 @@ def update_dimension(params = {}, options = {}) # tls_config: { # security_policy: "SecurityPolicy", # }, + # server_certificate_config: { + # enable_ocsp_check: false, + # }, # }) # # @example Response structure @@ -15075,7 +15099,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-iot' - context[:gem_version] = '1.119.0' + context[:gem_version] = '1.120.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb index 88485f1b2ce..4524e1d3ab4 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/client_api.rb @@ -516,6 +516,7 @@ module ClientApi ElasticsearchType = Shapes::StringShape.new(name: 'ElasticsearchType') EnableCachingForHttp = Shapes::BooleanShape.new(name: 'EnableCachingForHttp') EnableIoTLoggingParams = Shapes::StructureShape.new(name: 'EnableIoTLoggingParams') + EnableOCSPCheck = Shapes::BooleanShape.new(name: 'EnableOCSPCheck') EnableTopicRuleRequest = Shapes::StructureShape.new(name: 'EnableTopicRuleRequest') Enabled = Shapes::BooleanShape.new(name: 'Enabled') EnabledBoolean = Shapes::BooleanShape.new(name: 'EnabledBoolean') @@ -1092,6 +1093,7 @@ module ClientApi SecurityProfileTargetMappings = Shapes::ListShape.new(name: 'SecurityProfileTargetMappings') SecurityProfileTargets = Shapes::ListShape.new(name: 'SecurityProfileTargets') ServerCertificateArns = Shapes::ListShape.new(name: 'ServerCertificateArns') + ServerCertificateConfig = Shapes::StructureShape.new(name: 'ServerCertificateConfig') ServerCertificateStatus = Shapes::StringShape.new(name: 'ServerCertificateStatus') ServerCertificateStatusDetail = Shapes::StringShape.new(name: 'ServerCertificateStatusDetail') ServerCertificateSummary = Shapes::StructureShape.new(name: 'ServerCertificateSummary') @@ -1979,6 +1981,7 @@ module ClientApi CreateDomainConfigurationRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, location_name: "serviceType")) CreateDomainConfigurationRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "tags")) CreateDomainConfigurationRequest.add_member(:tls_config, Shapes::ShapeRef.new(shape: TlsConfig, location_name: "tlsConfig")) + CreateDomainConfigurationRequest.add_member(:server_certificate_config, Shapes::ShapeRef.new(shape: ServerCertificateConfig, location_name: "serverCertificateConfig")) CreateDomainConfigurationRequest.struct_class = Types::CreateDomainConfigurationRequest CreateDomainConfigurationResponse.add_member(:domain_configuration_name, Shapes::ShapeRef.new(shape: DomainConfigurationName, location_name: "domainConfigurationName")) @@ -2605,6 +2608,7 @@ module ClientApi DescribeDomainConfigurationResponse.add_member(:domain_type, Shapes::ShapeRef.new(shape: DomainType, location_name: "domainType")) DescribeDomainConfigurationResponse.add_member(:last_status_change_date, Shapes::ShapeRef.new(shape: DateType, location_name: "lastStatusChangeDate")) DescribeDomainConfigurationResponse.add_member(:tls_config, Shapes::ShapeRef.new(shape: TlsConfig, location_name: "tlsConfig")) + DescribeDomainConfigurationResponse.add_member(:server_certificate_config, Shapes::ShapeRef.new(shape: ServerCertificateConfig, location_name: "serverCertificateConfig")) DescribeDomainConfigurationResponse.struct_class = Types::DescribeDomainConfigurationResponse DescribeEndpointRequest.add_member(:endpoint_type, Shapes::ShapeRef.new(shape: EndpointType, location: "querystring", location_name: "endpointType")) @@ -4486,6 +4490,9 @@ module ClientApi ServerCertificateArns.member = Shapes::ShapeRef.new(shape: AcmCertificateArn) + ServerCertificateConfig.add_member(:enable_ocsp_check, Shapes::ShapeRef.new(shape: EnableOCSPCheck, location_name: "enableOCSPCheck")) + ServerCertificateConfig.struct_class = Types::ServerCertificateConfig + ServerCertificateSummary.add_member(:server_certificate_arn, Shapes::ShapeRef.new(shape: AcmCertificateArn, location_name: "serverCertificateArn")) ServerCertificateSummary.add_member(:server_certificate_status, Shapes::ShapeRef.new(shape: ServerCertificateStatus, location_name: "serverCertificateStatus")) ServerCertificateSummary.add_member(:server_certificate_status_detail, Shapes::ShapeRef.new(shape: ServerCertificateStatusDetail, location_name: "serverCertificateStatusDetail")) @@ -5005,6 +5012,7 @@ module ClientApi UpdateDomainConfigurationRequest.add_member(:domain_configuration_status, Shapes::ShapeRef.new(shape: DomainConfigurationStatus, location_name: "domainConfigurationStatus")) UpdateDomainConfigurationRequest.add_member(:remove_authorizer_config, Shapes::ShapeRef.new(shape: RemoveAuthorizerConfig, location_name: "removeAuthorizerConfig")) UpdateDomainConfigurationRequest.add_member(:tls_config, Shapes::ShapeRef.new(shape: TlsConfig, location_name: "tlsConfig")) + UpdateDomainConfigurationRequest.add_member(:server_certificate_config, Shapes::ShapeRef.new(shape: ServerCertificateConfig, location_name: "serverCertificateConfig")) UpdateDomainConfigurationRequest.struct_class = Types::UpdateDomainConfigurationRequest UpdateDomainConfigurationResponse.add_member(:domain_configuration_name, Shapes::ShapeRef.new(shape: ReservedDomainConfigurationName, location_name: "domainConfigurationName")) diff --git a/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb b/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb index 351d97753e2..8cbe8b03fe3 100644 --- a/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb +++ b/gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb @@ -2598,6 +2598,10 @@ class CreateDimensionResponse < Struct.new( # An object that specifies the TLS configuration for a domain. # @return [Types::TlsConfig] # + # @!attribute [rw] server_certificate_config + # The server certificate configuration. + # @return [Types::ServerCertificateConfig] + # class CreateDomainConfigurationRequest < Struct.new( :domain_configuration_name, :domain_name, @@ -2606,7 +2610,8 @@ class CreateDomainConfigurationRequest < Struct.new( :authorizer_config, :service_type, :tags, - :tls_config) + :tls_config, + :server_certificate_config) SENSITIVE = [] include Aws::Structure end @@ -5404,6 +5409,10 @@ class DescribeDomainConfigurationRequest < Struct.new( # An object that specifies the TLS configuration for a domain. # @return [Types::TlsConfig] # + # @!attribute [rw] server_certificate_config + # The server certificate configuration. + # @return [Types::ServerCertificateConfig] + # class DescribeDomainConfigurationResponse < Struct.new( :domain_configuration_name, :domain_configuration_arn, @@ -5414,7 +5423,8 @@ class DescribeDomainConfigurationResponse < Struct.new( :service_type, :domain_type, :last_status_change_date, - :tls_config) + :tls_config, + :server_certificate_config) SENSITIVE = [] include Aws::Structure end @@ -13614,6 +13624,27 @@ class SecurityProfileTargetMapping < Struct.new( include Aws::Structure end + # The server certificate configuration. + # + # @!attribute [rw] enable_ocsp_check + # A Boolean value that indicates whether Online Certificate Status + # Protocol (OCSP) server certificate check is enabled or not. + # + # For more information, see [Configuring OCSP server-certificate + # stapling in domain configuration][1] from Amazon Web Services IoT + # Core Developer Guide. + # + # + # + # [1]: https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-domain-ocsp-config.html + # @return [Boolean] + # + class ServerCertificateConfig < Struct.new( + :enable_ocsp_check) + SENSITIVE = [] + include Aws::Structure + end + # An object that contains information about a server certificate. # # @!attribute [rw] server_certificate_arn @@ -15945,12 +15976,17 @@ class UpdateDimensionResponse < Struct.new( # An object that specifies the TLS configuration for a domain. # @return [Types::TlsConfig] # + # @!attribute [rw] server_certificate_config + # The server certificate configuration. + # @return [Types::ServerCertificateConfig] + # class UpdateDomainConfigurationRequest < Struct.new( :domain_configuration_name, :authorizer_config, :domain_configuration_status, :remove_authorizer_config, - :tls_config) + :tls_config, + :server_certificate_config) SENSITIVE = [] include Aws::Structure end diff --git a/gems/aws-sdk-iot/sig/client.rbs b/gems/aws-sdk-iot/sig/client.rbs index cf4f518c3f9..862d804a849 100644 --- a/gems/aws-sdk-iot/sig/client.rbs +++ b/gems/aws-sdk-iot/sig/client.rbs @@ -401,6 +401,9 @@ module Aws ], ?tls_config: { security_policy: ::String? + }, + ?server_certificate_config: { + enable_ocsp_check: bool? } ) -> _CreateDomainConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDomainConfigurationResponseSuccess @@ -2064,6 +2067,7 @@ module Aws def domain_type: () -> ("ENDPOINT" | "AWS_MANAGED" | "CUSTOMER_MANAGED") def last_status_change_date: () -> ::Time def tls_config: () -> Types::TlsConfig + def server_certificate_config: () -> Types::ServerCertificateConfig end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/IoT/Client.html#describe_domain_configuration-instance_method def describe_domain_configuration: ( @@ -4423,6 +4427,9 @@ module Aws ?remove_authorizer_config: bool, ?tls_config: { security_policy: ::String? + }, + ?server_certificate_config: { + enable_ocsp_check: bool? } ) -> _UpdateDomainConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDomainConfigurationResponseSuccess diff --git a/gems/aws-sdk-iot/sig/types.rbs b/gems/aws-sdk-iot/sig/types.rbs index 45f5f7549cb..38665744b77 100644 --- a/gems/aws-sdk-iot/sig/types.rbs +++ b/gems/aws-sdk-iot/sig/types.rbs @@ -718,6 +718,7 @@ module Aws::IoT attr_accessor service_type: ("DATA" | "CREDENTIAL_PROVIDER" | "JOBS") attr_accessor tags: ::Array[Types::Tag] attr_accessor tls_config: Types::TlsConfig + attr_accessor server_certificate_config: Types::ServerCertificateConfig SENSITIVE: [] end @@ -1593,6 +1594,7 @@ module Aws::IoT attr_accessor domain_type: ("ENDPOINT" | "AWS_MANAGED" | "CUSTOMER_MANAGED") attr_accessor last_status_change_date: ::Time attr_accessor tls_config: Types::TlsConfig + attr_accessor server_certificate_config: Types::ServerCertificateConfig SENSITIVE: [] end @@ -3992,6 +3994,11 @@ module Aws::IoT SENSITIVE: [] end + class ServerCertificateConfig + attr_accessor enable_ocsp_check: bool + SENSITIVE: [] + end + class ServerCertificateSummary attr_accessor server_certificate_arn: ::String attr_accessor server_certificate_status: ("INVALID" | "VALID") @@ -4639,6 +4646,7 @@ module Aws::IoT attr_accessor domain_configuration_status: ("ENABLED" | "DISABLED") attr_accessor remove_authorizer_config: bool attr_accessor tls_config: Types::TlsConfig + attr_accessor server_certificate_config: Types::ServerCertificateConfig SENSITIVE: [] end diff --git a/gems/aws-sdk-pricing/CHANGELOG.md b/gems/aws-sdk-pricing/CHANGELOG.md index 2434dc35f1c..1308c08c38b 100644 --- a/gems/aws-sdk-pricing/CHANGELOG.md +++ b/gems/aws-sdk-pricing/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.55.0 (2024-02-09) +------------------ + +* Feature - Add Throttling Exception to all APIs. + 1.54.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-pricing/VERSION b/gems/aws-sdk-pricing/VERSION index b7921ae87bc..094d6ad00ce 100644 --- a/gems/aws-sdk-pricing/VERSION +++ b/gems/aws-sdk-pricing/VERSION @@ -1 +1 @@ -1.54.0 +1.55.0 diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing.rb index 809b88a69d5..1614fe2362d 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing.rb @@ -53,6 +53,6 @@ # @!group service module Aws::Pricing - GEM_VERSION = '1.54.0' + GEM_VERSION = '1.55.0' end diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client.rb index 6b54725ec94..f0b36fc1793 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client.rb @@ -743,7 +743,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-pricing' - context[:gem_version] = '1.54.0' + context[:gem_version] = '1.55.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client_api.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client_api.rb index a65300b7905..be2e43d8f61 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client_api.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/client_api.rb @@ -51,6 +51,7 @@ module ClientApi ServiceList = Shapes::ListShape.new(name: 'ServiceList') String = Shapes::StringShape.new(name: 'String') SynthesizedJsonPriceListJsonItem = Shapes::StringShape.new(name: 'SynthesizedJsonPriceListJsonItem') + ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException') errorMessage = Shapes::StringShape.new(name: 'errorMessage') AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "Message")) @@ -155,6 +156,9 @@ module ClientApi ServiceList.member = Shapes::ShapeRef.new(shape: Service) + ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: errorMessage, location_name: "Message")) + ThrottlingException.struct_class = Types::ThrottlingException + # @api private API = Seahorse::Model::Api.new.tap do |api| @@ -185,6 +189,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException) o.errors << Shapes::ShapeRef.new(shape: NotFoundException) o.errors << Shapes::ShapeRef.new(shape: InternalErrorException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException) o[:pager] = Aws::Pager.new( limit_key: "max_results", @@ -204,6 +209,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException) o.errors << Shapes::ShapeRef.new(shape: NotFoundException) o.errors << Shapes::ShapeRef.new(shape: InternalErrorException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException) o[:pager] = Aws::Pager.new( limit_key: "max_results", @@ -223,6 +229,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: NotFoundException) o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) o.errors << Shapes::ShapeRef.new(shape: InternalErrorException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) end) api.add_operation(:get_products, Seahorse::Model::Operation.new.tap do |o| @@ -235,6 +242,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: InvalidNextTokenException) o.errors << Shapes::ShapeRef.new(shape: NotFoundException) o.errors << Shapes::ShapeRef.new(shape: InternalErrorException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException) o[:pager] = Aws::Pager.new( limit_key: "max_results", @@ -255,6 +263,7 @@ module ClientApi o.errors << Shapes::ShapeRef.new(shape: NotFoundException) o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException) o.errors << Shapes::ShapeRef.new(shape: InternalErrorException) + o.errors << Shapes::ShapeRef.new(shape: ThrottlingException) o.errors << Shapes::ShapeRef.new(shape: ExpiredNextTokenException) o[:pager] = Aws::Pager.new( limit_key: "max_results", diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/endpoint_provider.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/endpoint_provider.rb index 8975d873647..84189064a2f 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/endpoint_provider.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/endpoint_provider.rb @@ -32,7 +32,7 @@ def resolve_endpoint(parameters) raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both" end if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) - if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) + if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true) return Aws::Endpoints::Endpoint.new(url: "https://api.pricing-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {}) end raise ArgumentError, "FIPS is enabled but this partition does not support FIPS" diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/errors.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/errors.rb index 346c1338a60..b3a6f4d4c79 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/errors.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/errors.rb @@ -33,6 +33,7 @@ module Aws::Pricing # * {InvalidNextTokenException} # * {InvalidParameterException} # * {NotFoundException} + # * {ThrottlingException} # # Additionally, error classes are dynamically generated for service errors based on the error code # if they are not defined above. @@ -83,6 +84,10 @@ def initialize(context, message, data = Aws::EmptyStructure.new) def message @message || @data[:message] end + + def retryable? + true + end end class InvalidNextTokenException < ServiceError @@ -130,5 +135,28 @@ def message end end + class ThrottlingException < ServiceError + + # @param [Seahorse::Client::RequestContext] context + # @param [String] message + # @param [Aws::Pricing::Types::ThrottlingException] data + def initialize(context, message, data = Aws::EmptyStructure.new) + super(context, message, data) + end + + # @return [String] + def message + @message || @data[:message] + end + + def retryable? + true + end + + def throttling? + true + end + end + end end diff --git a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb index a5385cfb5aa..d0602baa9cf 100644 --- a/gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb +++ b/gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb @@ -508,5 +508,18 @@ class Service < Struct.new( include Aws::Structure end + # You've made too many requests exceeding service quotas. + # + # @!attribute [rw] message + # @return [String] + # + # @see http://docs.aws.amazon.com/goto/WebAPI/pricing-2017-10-15/ThrottlingException AWS API Documentation + # + class ThrottlingException < Struct.new( + :message) + SENSITIVE = [] + include Aws::Structure + end + end end diff --git a/gems/aws-sdk-pricing/sig/errors.rbs b/gems/aws-sdk-pricing/sig/errors.rbs index a9ff57c18f3..376087252d6 100644 --- a/gems/aws-sdk-pricing/sig/errors.rbs +++ b/gems/aws-sdk-pricing/sig/errors.rbs @@ -29,6 +29,9 @@ module Aws class NotFoundException < ::Aws::Errors::ServiceError def message: () -> ::String end + class ThrottlingException < ::Aws::Errors::ServiceError + def message: () -> ::String + end end end end diff --git a/gems/aws-sdk-pricing/sig/types.rbs b/gems/aws-sdk-pricing/sig/types.rbs index d977bb4c872..37263aa4cc7 100644 --- a/gems/aws-sdk-pricing/sig/types.rbs +++ b/gems/aws-sdk-pricing/sig/types.rbs @@ -135,5 +135,10 @@ module Aws::Pricing attr_accessor attribute_names: ::Array[::String] SENSITIVE: [] end + + class ThrottlingException + attr_accessor message: ::String + SENSITIVE: [] + end end end diff --git a/gems/aws-sdk-prometheusservice/CHANGELOG.md b/gems/aws-sdk-prometheusservice/CHANGELOG.md index e5820e97d26..40a0c343597 100644 --- a/gems/aws-sdk-prometheusservice/CHANGELOG.md +++ b/gems/aws-sdk-prometheusservice/CHANGELOG.md @@ -1,6 +1,11 @@ Unreleased Changes ------------------ +1.30.0 (2024-02-09) +------------------ + +* Feature - Overall documentation updates. + 1.29.0 (2024-01-26) ------------------ diff --git a/gems/aws-sdk-prometheusservice/VERSION b/gems/aws-sdk-prometheusservice/VERSION index 5e57fb89558..034552a83ee 100644 --- a/gems/aws-sdk-prometheusservice/VERSION +++ b/gems/aws-sdk-prometheusservice/VERSION @@ -1 +1 @@ -1.29.0 +1.30.0 diff --git a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice.rb b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice.rb index 75b441c43f5..61236688a88 100644 --- a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice.rb +++ b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice.rb @@ -53,6 +53,6 @@ # @!group service module Aws::PrometheusService - GEM_VERSION = '1.29.0' + GEM_VERSION = '1.30.0' end diff --git a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb index 91259458841..886bb1d4ea4 100644 --- a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb +++ b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client.rb @@ -388,22 +388,32 @@ def initialize(*args) # @!group API Operations - # Create an alert manager definition. - # - # @option params [required, String] :workspace_id - # The ID of the workspace in which to create the alert manager - # definition. - # - # @option params [required, String, StringIO, File] :data - # The alert manager definition data. + # The `CreateAlertManagerDefinition` operation creates the alert manager + # definition in a workspace. If a workspace already has an alert manager + # definition, don't use this operation to update it. Instead, use + # `PutAlertManagerDefinition`. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String, StringIO, File] :data + # The alert manager definition to add. A base64-encoded version of the + # YAML alert manager definition file. + # + # For details about the alert manager definition, see + # [AlertManagedDefinitionData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html + # + # @option params [required, String] :workspace_id + # The ID of the workspace to add the alert manager definition to. + # # @return [Types::CreateAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus @@ -411,9 +421,9 @@ def initialize(*args) # @example Request syntax with placeholder values # # resp = client.create_alert_manager_definition({ - # workspace_id: "WorkspaceId", # required - # data: "data", # required # client_token: "IdempotencyToken", + # data: "data", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure @@ -430,22 +440,24 @@ def create_alert_manager_definition(params = {}, options = {}) req.send_request(options) end - # Create logging configuration. - # - # @option params [required, String] :workspace_id - # The ID of the workspace to vend logs to. - # - # @option params [required, String] :log_group_arn - # The ARN of the CW log group to which the vended log data will be - # published. + # The `CreateLoggingConfiguration` operation creates a logging + # configuration for the workspace. Use this operation to set the + # CloudWatch log group to which the logs will be published to. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :log_group_arn + # The ARN of the CloudWatch log group to which the vended log data will + # be published. This log group must exist prior to calling this API. + # + # @option params [required, String] :workspace_id + # The ID of the workspace to create the logging configuration for. + # # @return [Types::CreateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus @@ -453,9 +465,9 @@ def create_alert_manager_definition(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.create_logging_configuration({ - # workspace_id: "WorkspaceId", # required - # log_group_arn: "LogGroupArn", # required # client_token: "IdempotencyToken", + # log_group_arn: "LogGroupArn", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure @@ -472,50 +484,67 @@ def create_logging_configuration(params = {}, options = {}) req.send_request(options) end - # Create a rule group namespace. - # - # @option params [required, String] :workspace_id - # The ID of the workspace in which to create the rule group namespace. + # The `CreateRuleGroupsNamespace` operation creates a rule groups + # namespace within a workspace. A rule groups namespace is associated + # with exactly one rules file. A workspace can have multiple rule groups + # namespaces. # - # @option params [required, String] :name - # The rule groups namespace name. - # - # @option params [required, String, StringIO, File] :data - # The namespace data that define the rule groups. + # Use this operation only to create new rule groups namespaces. To + # update an existing rule groups namespace, use + # `PutRuleGroupsNamespace`. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String, StringIO, File] :data + # The rules file to use in the new namespace. + # + # Contains the base64-encoded version of the YAML rules file. + # + # For details about the rule groups namespace structure, see + # [RuleGroupsNamespaceData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html + # + # @option params [required, String] :name + # The name for the new rule groups namespace. + # # @option params [Hash] :tags - # Optional, user-provided tags for this rule groups namespace. + # The list of tag keys and values to associate with the rule groups + # namespace. + # + # @option params [required, String] :workspace_id + # The ID of the workspace to add the rule groups namespace. # # @return [Types::CreateRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String # * {Types::CreateRuleGroupsNamespaceResponse#arn #arn} => String + # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String # * {Types::CreateRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus # * {Types::CreateRuleGroupsNamespaceResponse#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.create_rule_groups_namespace({ - # workspace_id: "WorkspaceId", # required - # name: "RuleGroupsNamespaceName", # required - # data: "data", # required # client_token: "IdempotencyToken", + # data: "data", # required + # name: "RuleGroupsNamespaceName", # required # tags: { # "TagKey" => "TagValue", # }, + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure # - # resp.name #=> String # resp.arn #=> String + # resp.name #=> String # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" # resp.status.status_reason #=> String # resp.tags #=> Hash @@ -530,36 +559,68 @@ def create_rule_groups_namespace(params = {}, options = {}) req.send_request(options) end - # Create a scraper. + # The `CreateScraper` operation creates a scraper to collect metrics. A + # scraper pulls metrics from Prometheus-compatible sources within an + # Amazon EKS cluster, and sends them to your Amazon Managed Service for + # Prometheus workspace. You can configure the scraper to control what + # metrics are collected, and what transformations are applied prior to + # sending them to your workspace. # - # @option params [String] :alias - # An optional user-assigned alias for this scraper. This alias is for - # user reference and does not need to be unique. + # If needed, an IAM role will be created for you that gives Amazon + # Managed Service for Prometheus access to the metrics in your cluster. + # For more information, see [Using roles for scraping metrics from + # EKS][1] in the *Amazon Managed Service for Prometheus User Guide*. # - # @option params [required, Types::ScrapeConfiguration] :scrape_configuration - # The configuration used to create the scraper. + # You cannot update a scraper. If you want to change the configuration + # of the scraper, create a new scraper and delete the old one. # - # @option params [required, Types::Source] :source - # The source that the scraper will be discovering and collecting metrics - # from. + # The `scrapeConfiguration` parameter contains the base64-encoded + # version of the YAML configuration file. + # + # For more information about collectors, including what metrics are + # collected, and how to configure the scraper, see [Amazon Web Services + # managed collectors][2] in the *Amazon Managed Service for Prometheus + # User Guide*. + # + # # - # @option params [required, Types::Destination] :destination - # The destination that the scraper will be producing metrics to. + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper + # [2]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html + # + # @option params [String] :alias + # (optional) a name to associate with the scraper. This is for your use, + # and does not need to be unique. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # (Optional) A unique, case-sensitive identifier that you can provide to + # ensure the idempotency of the request. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, Types::Destination] :destination + # The Amazon Managed Service for Prometheus workspace to send metrics + # to. + # + # @option params [required, Types::ScrapeConfiguration] :scrape_configuration + # The configuration file to use in the new scraper. For more + # information, see [Scraper + # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) + # in the *Amazon Managed Service for Prometheus User Guide*. + # + # @option params [required, Types::Source] :source + # The Amazon EKS cluster from which the scraper will collect metrics. + # # @option params [Hash] :tags - # Optional, user-provided tags for this scraper. + # (Optional) The list of tag keys and values to associate with the + # scraper. # # @return [Types::CreateScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String # * {Types::CreateScraperResponse#arn #arn} => String + # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String # * {Types::CreateScraperResponse#status #status} => Types::ScraperStatus # * {Types::CreateScraperResponse#tags #tags} => Hash<String,String> # @@ -567,6 +628,12 @@ def create_rule_groups_namespace(params = {}, options = {}) # # resp = client.create_scraper({ # alias: "ScraperAlias", + # client_token: "IdempotencyToken", + # destination: { # required + # amp_configuration: { + # workspace_arn: "WorkspaceArn", # required + # }, + # }, # scrape_configuration: { # required # configuration_blob: "data", # }, @@ -577,12 +644,6 @@ def create_rule_groups_namespace(params = {}, options = {}) # subnet_ids: ["SubnetId"], # required # }, # }, - # destination: { # required - # amp_configuration: { - # workspace_arn: "WorkspaceArn", # required - # }, - # }, - # client_token: "IdempotencyToken", # tags: { # "TagKey" => "TagValue", # }, @@ -590,8 +651,8 @@ def create_rule_groups_namespace(params = {}, options = {}) # # @example Response structure # - # resp.scraper_id #=> String # resp.arn #=> String + # resp.scraper_id #=> String # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" # resp.tags #=> Hash # resp.tags["TagKey"] #=> String @@ -605,53 +666,64 @@ def create_scraper(params = {}, options = {}) req.send_request(options) end - # Creates a new AMP workspace. + # Creates a Prometheus workspace. A workspace is a logical space + # dedicated to the storage and querying of Prometheus metrics. You can + # have one or more workspaces in each Region in your account. # # @option params [String] :alias - # An optional user-assigned alias for this workspace. This alias is for - # user reference and does not need to be unique. + # An alias that you assign to this workspace to help you identify it. It + # does not need to be unique. + # + # Blank spaces at the beginning or end of the alias that you specify + # will be trimmed from the value used. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # - # @option params [Hash] :tags - # Optional, user-provided tags for this workspace. - # # @option params [String] :kms_key_arn - # Optional, customer managed KMS key used to encrypt data for this - # workspace + # (optional) The ARN for a customer managed KMS key to use for + # encrypting data within your workspace. For more information about + # using your own key in your workspace, see [Encryption at rest][1] in + # the *Amazon Managed Service for Prometheus User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html + # + # @option params [Hash] :tags + # The list of tag keys and values to associate with the workspace. # # @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String # * {Types::CreateWorkspaceResponse#arn #arn} => String + # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String # * {Types::CreateWorkspaceResponse#status #status} => Types::WorkspaceStatus # * {Types::CreateWorkspaceResponse#tags #tags} => Hash<String,String> - # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String + # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String # # @example Request syntax with placeholder values # # resp = client.create_workspace({ # alias: "WorkspaceAlias", # client_token: "IdempotencyToken", + # kms_key_arn: "KmsKeyArn", # tags: { # "TagKey" => "TagValue", # }, - # kms_key_arn: "KmsKeyArn", # }) # # @example Response structure # - # resp.workspace_id #=> String # resp.arn #=> String + # resp.kms_key_arn #=> String # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" # resp.tags #=> Hash # resp.tags["TagKey"] #=> String - # resp.kms_key_arn #=> String + # resp.workspace_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace AWS API Documentation # @@ -662,26 +734,25 @@ def create_workspace(params = {}, options = {}) req.send_request(options) end - # Deletes an alert manager definition. - # - # @option params [required, String] :workspace_id - # The ID of the workspace in which to delete the alert manager - # definition. + # Deletes the alert manager definition from a workspace. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :workspace_id + # The ID of the workspace to delete the alert manager definition from. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_alert_manager_definition({ - # workspace_id: "WorkspaceId", # required # client_token: "IdempotencyToken", + # workspace_id: "WorkspaceId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinition AWS API Documentation @@ -693,25 +764,26 @@ def delete_alert_manager_definition(params = {}, options = {}) req.send_request(options) end - # Delete logging configuration. - # - # @option params [required, String] :workspace_id - # The ID of the workspace to vend logs to. + # Deletes the logging configuration for a workspace. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :workspace_id + # The ID of the workspace containing the logging configuration to + # delete. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_logging_configuration({ - # workspace_id: "WorkspaceId", # required # client_token: "IdempotencyToken", + # workspace_id: "WorkspaceId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfiguration AWS API Documentation @@ -723,29 +795,31 @@ def delete_logging_configuration(params = {}, options = {}) req.send_request(options) end - # Delete a rule groups namespace. - # - # @option params [required, String] :workspace_id - # The ID of the workspace to delete rule group definition. - # - # @option params [required, String] :name - # The rule groups namespace name. + # Deletes one rule groups namespace and its associated rule groups + # definition. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :name + # The name of the rule groups namespace to delete. + # + # @option params [required, String] :workspace_id + # The ID of the workspace containing the rule groups namespace and + # definition to delete. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_rule_groups_namespace({ - # workspace_id: "WorkspaceId", # required - # name: "RuleGroupsNamespaceName", # required # client_token: "IdempotencyToken", + # name: "RuleGroupsNamespaceName", # required + # workspace_id: "WorkspaceId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespace AWS API Documentation @@ -757,18 +831,19 @@ def delete_rule_groups_namespace(params = {}, options = {}) req.send_request(options) end - # Deletes a scraper. - # - # @option params [required, String] :scraper_id - # The ID of the scraper to delete. + # The `DeleteScraper` operation deletes one scraper, and stops any + # metrics collection that the scraper performs. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # (Optional) A unique, case-sensitive identifier that you can provide to + # ensure the idempotency of the request. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :scraper_id + # The ID of the scraper to delete. + # # @return [Types::DeleteScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteScraperResponse#scraper_id #scraper_id} => String @@ -777,8 +852,8 @@ def delete_rule_groups_namespace(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.delete_scraper({ - # scraper_id: "ScraperId", # required # client_token: "IdempotencyToken", + # scraper_id: "ScraperId", # required # }) # # @example Response structure @@ -795,25 +870,31 @@ def delete_scraper(params = {}, options = {}) req.send_request(options) end - # Deletes an AMP workspace. + # Deletes an existing workspace. # - # @option params [required, String] :workspace_id - # The ID of the workspace to delete. + # When you delete a workspace, the data that has been ingested into it + # is not immediately deleted. It will be permanently deleted within one + # month. + # + # # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :workspace_id + # The ID of the workspace to delete. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_workspace({ - # workspace_id: "WorkspaceId", # required # client_token: "IdempotencyToken", + # workspace_id: "WorkspaceId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace AWS API Documentation @@ -825,10 +906,11 @@ def delete_workspace(params = {}, options = {}) req.send_request(options) end - # Describes an alert manager definition. + # Retrieves the full information about the alert manager definition for + # a workspace. # # @option params [required, String] :workspace_id - # The ID of the workspace to describe. + # The ID of the workspace to retrieve the alert manager definition from. # # @return [Types::DescribeAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -842,11 +924,11 @@ def delete_workspace(params = {}, options = {}) # # @example Response structure # - # resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" - # resp.alert_manager_definition.status.status_reason #=> String - # resp.alert_manager_definition.data #=> String # resp.alert_manager_definition.created_at #=> Time + # resp.alert_manager_definition.data #=> String # resp.alert_manager_definition.modified_at #=> Time + # resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" + # resp.alert_manager_definition.status.status_reason #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinition AWS API Documentation # @@ -857,10 +939,11 @@ def describe_alert_manager_definition(params = {}, options = {}) req.send_request(options) end - # Describes logging configuration. + # Returns complete information about the current logging configuration + # of the workspace. # # @option params [required, String] :workspace_id - # The ID of the workspace to vend logs to. + # The ID of the workspace to describe the logging configuration for. # # @return [Types::DescribeLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -874,12 +957,12 @@ def describe_alert_manager_definition(params = {}, options = {}) # # @example Response structure # + # resp.logging_configuration.created_at #=> Time + # resp.logging_configuration.log_group_arn #=> String + # resp.logging_configuration.modified_at #=> Time # resp.logging_configuration.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" # resp.logging_configuration.status.status_reason #=> String # resp.logging_configuration.workspace #=> String - # resp.logging_configuration.log_group_arn #=> String - # resp.logging_configuration.created_at #=> Time - # resp.logging_configuration.modified_at #=> Time # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfiguration AWS API Documentation # @@ -890,13 +973,15 @@ def describe_logging_configuration(params = {}, options = {}) req.send_request(options) end - # Describe a rule groups namespace. - # - # @option params [required, String] :workspace_id - # The ID of the workspace to describe. + # Returns complete information about one rule groups namespace. To + # retrieve a list of rule groups namespaces, use + # `ListRuleGroupsNamespaces`. # # @option params [required, String] :name - # The rule groups namespace. + # The name of the rule groups namespace that you want information for. + # + # @option params [required, String] :workspace_id + # The ID of the workspace containing the rule groups namespace. # # @return [Types::DescribeRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -905,19 +990,19 @@ def describe_logging_configuration(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.describe_rule_groups_namespace({ - # workspace_id: "WorkspaceId", # required # name: "RuleGroupsNamespaceName", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure # # resp.rule_groups_namespace.arn #=> String + # resp.rule_groups_namespace.created_at #=> Time + # resp.rule_groups_namespace.data #=> String + # resp.rule_groups_namespace.modified_at #=> Time # resp.rule_groups_namespace.name #=> String # resp.rule_groups_namespace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" # resp.rule_groups_namespace.status.status_reason #=> String - # resp.rule_groups_namespace.data #=> String - # resp.rule_groups_namespace.created_at #=> Time - # resp.rule_groups_namespace.modified_at #=> Time # resp.rule_groups_namespace.tags #=> Hash # resp.rule_groups_namespace.tags["TagKey"] #=> String # @@ -930,10 +1015,11 @@ def describe_rule_groups_namespace(params = {}, options = {}) req.send_request(options) end - # Describe an existing scraper. + # The `DescribeScraper` operation displays information about an existing + # scraper. # # @option params [required, String] :scraper_id - # The IDs of the scraper to describe. + # The ID of the scraper to describe. # # @return [Types::DescribeScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -948,22 +1034,22 @@ def describe_rule_groups_namespace(params = {}, options = {}) # @example Response structure # # resp.scraper.alias #=> String - # resp.scraper.scraper_id #=> String # resp.scraper.arn #=> String - # resp.scraper.role_arn #=> String - # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" # resp.scraper.created_at #=> Time + # resp.scraper.destination.amp_configuration.workspace_arn #=> String # resp.scraper.last_modified_at #=> Time - # resp.scraper.tags #=> Hash - # resp.scraper.tags["TagKey"] #=> String - # resp.scraper.status_reason #=> String + # resp.scraper.role_arn #=> String # resp.scraper.scrape_configuration.configuration_blob #=> String + # resp.scraper.scraper_id #=> String # resp.scraper.source.eks_configuration.cluster_arn #=> String # resp.scraper.source.eks_configuration.security_group_ids #=> Array # resp.scraper.source.eks_configuration.security_group_ids[0] #=> String # resp.scraper.source.eks_configuration.subnet_ids #=> Array # resp.scraper.source.eks_configuration.subnet_ids[0] #=> String - # resp.scraper.destination.amp_configuration.workspace_arn #=> String + # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" + # resp.scraper.status_reason #=> String + # resp.scraper.tags #=> Hash + # resp.scraper.tags["TagKey"] #=> String # # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): @@ -980,7 +1066,7 @@ def describe_scraper(params = {}, options = {}) req.send_request(options) end - # Describes an existing AMP workspace. + # Returns information about an existing workspace. # # @option params [required, String] :workspace_id # The ID of the workspace to describe. @@ -997,15 +1083,15 @@ def describe_scraper(params = {}, options = {}) # # @example Response structure # - # resp.workspace.workspace_id #=> String # resp.workspace.alias #=> String # resp.workspace.arn #=> String - # resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" - # resp.workspace.prometheus_endpoint #=> String # resp.workspace.created_at #=> Time + # resp.workspace.kms_key_arn #=> String + # resp.workspace.prometheus_endpoint #=> String + # resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" # resp.workspace.tags #=> Hash # resp.workspace.tags["TagKey"] #=> String - # resp.workspace.kms_key_arn #=> String + # resp.workspace.workspace_id #=> String # # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): @@ -1022,7 +1108,8 @@ def describe_workspace(params = {}, options = {}) req.send_request(options) end - # Gets a default configuration. + # The `GetDefaultScraperConfiguration` operation returns the default + # scraper configuration used when Amazon EKS creates a scraper for you. # # @return [Types::GetDefaultScraperConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1041,51 +1128,57 @@ def get_default_scraper_configuration(params = {}, options = {}) req.send_request(options) end - # Lists rule groups namespaces. + # Returns a list of rule groups namespaces in a workspace. # - # @option params [required, String] :workspace_id - # The ID of the workspace. + # @option params [Integer] :max_results + # The maximum number of results to return. The default is 100. # # @option params [String] :name - # Optional filter for rule groups namespace name. Only the rule groups - # namespace that begin with this value will be returned. + # Use this parameter to filter the rule groups namespaces that are + # returned. Only the namespaces with names that begin with the value + # that you specify are returned. # # @option params [String] :next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous - # ListRuleGroupsNamespaces request. + # The token for the next set of items to return. You receive this token + # from a previous call, and use it to get the next page of results. The + # other parameters must be the same as the initial call. # - # @option params [Integer] :max_results - # Maximum results to return in response (default=100, maximum=1000). + # For example, if your initial request has `maxResults` of 10, and there + # are 12 rule groups namespaces to return, then your initial request + # will return 10 and a `nextToken`. Using the next token in a subsequent + # call will return the remaining 2 namespaces. + # + # @option params [required, String] :workspace_id + # The ID of the workspace containing the rule groups namespaces. # # @return [Types::ListRuleGroupsNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array<Types::RuleGroupsNamespaceSummary> # * {Types::ListRuleGroupsNamespacesResponse#next_token #next_token} => String + # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array<Types::RuleGroupsNamespaceSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_rule_groups_namespaces({ - # workspace_id: "WorkspaceId", # required + # max_results: 1, # name: "RuleGroupsNamespaceName", # next_token: "PaginationToken", - # max_results: 1, + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure # + # resp.next_token #=> String # resp.rule_groups_namespaces #=> Array # resp.rule_groups_namespaces[0].arn #=> String + # resp.rule_groups_namespaces[0].created_at #=> Time + # resp.rule_groups_namespaces[0].modified_at #=> Time # resp.rule_groups_namespaces[0].name #=> String # resp.rule_groups_namespaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" # resp.rule_groups_namespaces[0].status.status_reason #=> String - # resp.rule_groups_namespaces[0].created_at #=> Time - # resp.rule_groups_namespaces[0].modified_at #=> Time # resp.rule_groups_namespaces[0].tags #=> Hash # resp.rule_groups_namespaces[0].tags["TagKey"] #=> String - # resp.next_token #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespaces AWS API Documentation # @@ -1096,25 +1189,43 @@ def list_rule_groups_namespaces(params = {}, options = {}) req.send_request(options) end - # Lists all scrapers in a customer account, including scrapers being - # created or deleted. You may provide filters to return a more specific - # list of results. + # The `ListScrapers` operation lists all of the scrapers in your + # account. This includes scrapers being created or deleted. You can + # optionally filter the returned list. # # @option params [Hash] :filters - # A list of scraper filters. + # (Optional) A list of key-value pairs to filter the list of scrapers + # returned. Keys include `status`, `sourceArn`, `destinationArn`, and + # `alias`. # - # @option params [String] :next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous ListScrapers - # request. + # Filters on the same key are `OR`'d together, and filters on different + # keys are `AND`'d together. For example, + # `status=ACTIVE&status=CREATING&alias=Test`, will return all scrapers + # that have the alias Test, and are either in status ACTIVE or CREATING. + # + # To find all active scrapers that are sending metrics to a specific + # Amazon Managed Service for Prometheus workspace, you would use the ARN + # of the workspace in a query: + # + # `status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012` + # + # If this is included, it filters the results to only the scrapers that + # match the filter. # # @option params [Integer] :max_results - # Maximum results to return in response (default=100, maximum=1000). + # Optional) The maximum number of scrapers to return in one + # `ListScrapers` operation. The range is 1-1000. + # + # If you omit this parameter, the default of 100 is used. + # + # @option params [String] :next_token + # (Optional) The token for the next set of items to return. (You + # received this token from a previous call.) # # @return [Types::ListScrapersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListScrapersResponse#scrapers #scrapers} => Array<Types::ScraperSummary> # * {Types::ListScrapersResponse#next_token #next_token} => String + # * {Types::ListScrapersResponse#scrapers #scrapers} => Array<Types::ScraperSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # @@ -1124,30 +1235,30 @@ def list_rule_groups_namespaces(params = {}, options = {}) # filters: { # "FilterKey" => ["FilterValue"], # }, - # next_token: "PaginationToken", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.scrapers #=> Array # resp.scrapers[0].alias #=> String - # resp.scrapers[0].scraper_id #=> String # resp.scrapers[0].arn #=> String - # resp.scrapers[0].role_arn #=> String - # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" # resp.scrapers[0].created_at #=> Time + # resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String # resp.scrapers[0].last_modified_at #=> Time - # resp.scrapers[0].tags #=> Hash - # resp.scrapers[0].tags["TagKey"] #=> String - # resp.scrapers[0].status_reason #=> String + # resp.scrapers[0].role_arn #=> String + # resp.scrapers[0].scraper_id #=> String # resp.scrapers[0].source.eks_configuration.cluster_arn #=> String # resp.scrapers[0].source.eks_configuration.security_group_ids #=> Array # resp.scrapers[0].source.eks_configuration.security_group_ids[0] #=> String # resp.scrapers[0].source.eks_configuration.subnet_ids #=> Array # resp.scrapers[0].source.eks_configuration.subnet_ids[0] #=> String - # resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String - # resp.next_token #=> String + # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED" + # resp.scrapers[0].status_reason #=> String + # resp.scrapers[0].tags #=> Hash + # resp.scrapers[0].tags["TagKey"] #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapers AWS API Documentation # @@ -1158,10 +1269,14 @@ def list_scrapers(params = {}, options = {}) req.send_request(options) end - # Lists the tags you have assigned to the resource. + # The `ListTagsForResource` operation returns the tags that are + # associated with an Amazon Managed Service for Prometheus resource. + # Currently, the only resources that can be tagged are workspaces and + # rule groups namespaces. # # @option params [required, String] :resource_arn - # The ARN of the resource. + # The ARN of the resource to list tages for. Must be a workspace or rule + # groups namespace resource. # # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -1187,48 +1302,57 @@ def list_tags_for_resource(params = {}, options = {}) req.send_request(options) end - # Lists all AMP workspaces, including workspaces being created or - # deleted. - # - # @option params [String] :next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous ListWorkspaces - # request. + # Lists all of the Amazon Managed Service for Prometheus workspaces in + # your account. This includes workspaces being created or deleted. # # @option params [String] :alias - # Optional filter for workspace alias. Only the workspaces with aliases - # that begin with this value will be returned. + # If this is included, it filters the results to only the workspaces + # with names that start with the value that you specify here. + # + # Amazon Managed Service for Prometheus will automatically strip any + # blank spaces from the beginning and end of the alias that you specify. # # @option params [Integer] :max_results - # Maximum results to return in response (default=100, maximum=1000). + # The maximum number of workspaces to return per request. The default is + # 100. + # + # @option params [String] :next_token + # The token for the next set of items to return. You receive this token + # from a previous call, and use it to get the next page of results. The + # other parameters must be the same as the initial call. + # + # For example, if your initial request has `maxResults` of 10, and there + # are 12 workspaces to return, then your initial request will return 10 + # and a `nextToken`. Using the next token in a subsequent call will + # return the remaining 2 workspaces. # # @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array<Types::WorkspaceSummary> # * {Types::ListWorkspacesResponse#next_token #next_token} => String + # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array<Types::WorkspaceSummary> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_workspaces({ - # next_token: "PaginationToken", # alias: "WorkspaceAlias", # max_results: 1, + # next_token: "PaginationToken", # }) # # @example Response structure # + # resp.next_token #=> String # resp.workspaces #=> Array - # resp.workspaces[0].workspace_id #=> String # resp.workspaces[0].alias #=> String # resp.workspaces[0].arn #=> String - # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" # resp.workspaces[0].created_at #=> Time + # resp.workspaces[0].kms_key_arn #=> String + # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED" # resp.workspaces[0].tags #=> Hash # resp.workspaces[0].tags["TagKey"] #=> String - # resp.workspaces[0].kms_key_arn #=> String - # resp.next_token #=> String + # resp.workspaces[0].workspace_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces AWS API Documentation # @@ -1239,22 +1363,32 @@ def list_workspaces(params = {}, options = {}) req.send_request(options) end - # Update an alert manager definition. - # - # @option params [required, String] :workspace_id - # The ID of the workspace in which to update the alert manager - # definition. - # - # @option params [required, String, StringIO, File] :data - # The alert manager definition data. + # Updates an existing alert manager definition in a workspace. If the + # workspace does not already have an alert manager definition, don't + # use this operation to create it. Instead, use + # `CreateAlertManagerDefinition`. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String, StringIO, File] :data + # The alert manager definition to use. A base64-encoded version of the + # YAML alert manager definition file. + # + # For details about the alert manager definition, see + # [AlertManagedDefinitionData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html + # + # @option params [required, String] :workspace_id + # The ID of the workspace to update the alert manager definition in. + # # @return [Types::PutAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PutAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus @@ -1262,9 +1396,9 @@ def list_workspaces(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.put_alert_manager_definition({ - # workspace_id: "WorkspaceId", # required - # data: "data", # required # client_token: "IdempotencyToken", + # data: "data", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure @@ -1281,44 +1415,61 @@ def put_alert_manager_definition(params = {}, options = {}) req.send_request(options) end - # Update a rule groups namespace. + # Updates an existing rule groups namespace within a workspace. A rule + # groups namespace is associated with exactly one rules file. A + # workspace can have multiple rule groups namespaces. # - # @option params [required, String] :workspace_id - # The ID of the workspace in which to update the rule group namespace. + # Use this operation only to update existing rule groups namespaces. To + # create a new rule groups namespace, use `CreateRuleGroupsNamespace`. # - # @option params [required, String] :name - # The rule groups namespace name. - # - # @option params [required, String, StringIO, File] :data - # The namespace data that define the rule groups. + # You can't use this operation to add tags to an existing rule groups + # namespace. Instead, use `TagResource`. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String, StringIO, File] :data + # The new rules file to use in the namespace. A base64-encoded version + # of the YAML rule groups file. + # + # For details about the rule groups namespace structure, see + # [RuleGroupsNamespaceData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html + # + # @option params [required, String] :name + # The name of the rule groups namespace that you are updating. + # + # @option params [required, String] :workspace_id + # The ID of the workspace where you are updating the rule groups + # namespace. + # # @return [Types::PutRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # - # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String # * {Types::PutRuleGroupsNamespaceResponse#arn #arn} => String + # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String # * {Types::PutRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus # * {Types::PutRuleGroupsNamespaceResponse#tags #tags} => Hash<String,String> # # @example Request syntax with placeholder values # # resp = client.put_rule_groups_namespace({ - # workspace_id: "WorkspaceId", # required - # name: "RuleGroupsNamespaceName", # required - # data: "data", # required # client_token: "IdempotencyToken", + # data: "data", # required + # name: "RuleGroupsNamespaceName", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure # - # resp.name #=> String # resp.arn #=> String + # resp.name #=> String # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED" # resp.status.status_reason #=> String # resp.tags #=> Hash @@ -1333,13 +1484,22 @@ def put_rule_groups_namespace(params = {}, options = {}) req.send_request(options) end - # Creates tags for the specified resource. + # The `TagResource` operation associates tags with an Amazon Managed + # Service for Prometheus resource. The only resources that can be tagged + # are workspaces and rule groups namespaces. + # + # If you specify a new tag key for the resource, this tag is appended to + # the list of tags associated with the resource. If you specify a tag + # key that is already associated with the resource, the new tag value + # that you specify replaces the previous value for that tag. # # @option params [required, String] :resource_arn - # The ARN of the resource. + # The ARN of the workspace or rule groups namespace to apply tags to. # # @option params [required, Hash] :tags - # The list of tags assigned to the resource. + # The list of tag keys and values to associate with the resource. + # + # Keys may not begin with `aws:`. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1361,13 +1521,15 @@ def tag_resource(params = {}, options = {}) req.send_request(options) end - # Deletes tags from the specified resource. + # Removes the specified tags from an Amazon Managed Service for + # Prometheus resource. The only resources that can be tagged are + # workspaces and rule groups namespaces. # # @option params [required, String] :resource_arn - # The ARN of the resource. + # The ARN of the workspace or rule groups namespace. # # @option params [required, Array] :tag_keys - # One or more tag keys + # The keys of the tags to remove. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -1387,22 +1549,23 @@ def untag_resource(params = {}, options = {}) req.send_request(options) end - # Update logging configuration. - # - # @option params [required, String] :workspace_id - # The ID of the workspace to vend logs to. - # - # @option params [required, String] :log_group_arn - # The ARN of the CW log group to which the vended log data will be - # published. + # Updates the log group ARN or the workspace ID of the current logging + # configuration. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :log_group_arn + # The ARN of the CloudWatch log group to which the vended log data will + # be published. + # + # @option params [required, String] :workspace_id + # The ID of the workspace to update the logging configuration for. + # # @return [Types::UpdateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus @@ -1410,9 +1573,9 @@ def untag_resource(params = {}, options = {}) # @example Request syntax with placeholder values # # resp = client.update_logging_configuration({ - # workspace_id: "WorkspaceId", # required - # log_group_arn: "LogGroupArn", # required # client_token: "IdempotencyToken", + # log_group_arn: "LogGroupArn", # required + # workspace_id: "WorkspaceId", # required # }) # # @example Response structure @@ -1429,29 +1592,32 @@ def update_logging_configuration(params = {}, options = {}) req.send_request(options) end - # Updates an AMP workspace alias. - # - # @option params [required, String] :workspace_id - # The ID of the workspace being updated. + # Updates the alias of an existing workspace. # # @option params [String] :alias - # The new alias of the workspace. + # The new alias for the workspace. It does not need to be unique. + # + # Amazon Managed Service for Prometheus will automatically strip any + # blank spaces from the beginning and end of the alias that you specify. # # @option params [String] :client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency of + # the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option.** # + # @option params [required, String] :workspace_id + # The ID of the workspace to update. + # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_workspace_alias({ - # workspace_id: "WorkspaceId", # required # alias: "WorkspaceAlias", # client_token: "IdempotencyToken", + # workspace_id: "WorkspaceId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias AWS API Documentation @@ -1476,7 +1642,7 @@ def build_request(operation_name, params = {}) params: params, config: config) context[:gem_name] = 'aws-sdk-prometheusservice' - context[:gem_version] = '1.29.0' + context[:gem_version] = '1.30.0' Seahorse::Client::Request.new(handlers, context) end diff --git a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client_api.rb b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client_api.rb index c2ac67043ef..c33bd7e7bd1 100644 --- a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client_api.rb +++ b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/client_api.rb @@ -137,10 +137,10 @@ module ClientApi AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message")) AccessDeniedException.struct_class = Types::AccessDeniedException - AlertManagerDefinitionDescription.add_member(:status, Shapes::ShapeRef.new(shape: AlertManagerDefinitionStatus, required: true, location_name: "status")) - AlertManagerDefinitionDescription.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) AlertManagerDefinitionDescription.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + AlertManagerDefinitionDescription.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) AlertManagerDefinitionDescription.add_member(:modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "modifiedAt")) + AlertManagerDefinitionDescription.add_member(:status, Shapes::ShapeRef.new(shape: AlertManagerDefinitionStatus, required: true, location_name: "status")) AlertManagerDefinitionDescription.struct_class = Types::AlertManagerDefinitionDescription AlertManagerDefinitionStatus.add_member(:status_code, Shapes::ShapeRef.new(shape: AlertManagerDefinitionStatusCode, required: true, location_name: "statusCode")) @@ -155,85 +155,85 @@ module ClientApi ConflictException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType")) ConflictException.struct_class = Types::ConflictException - CreateAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - CreateAlertManagerDefinitionRequest.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) CreateAlertManagerDefinitionRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateAlertManagerDefinitionRequest.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) + CreateAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) CreateAlertManagerDefinitionRequest.struct_class = Types::CreateAlertManagerDefinitionRequest CreateAlertManagerDefinitionResponse.add_member(:status, Shapes::ShapeRef.new(shape: AlertManagerDefinitionStatus, required: true, location_name: "status")) CreateAlertManagerDefinitionResponse.struct_class = Types::CreateAlertManagerDefinitionResponse - CreateLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - CreateLoggingConfigurationRequest.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) CreateLoggingConfigurationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateLoggingConfigurationRequest.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) + CreateLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) CreateLoggingConfigurationRequest.struct_class = Types::CreateLoggingConfigurationRequest CreateLoggingConfigurationResponse.add_member(:status, Shapes::ShapeRef.new(shape: LoggingConfigurationStatus, required: true, location_name: "status")) CreateLoggingConfigurationResponse.struct_class = Types::CreateLoggingConfigurationResponse - CreateRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - CreateRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) - CreateRuleGroupsNamespaceRequest.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) CreateRuleGroupsNamespaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateRuleGroupsNamespaceRequest.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) + CreateRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) CreateRuleGroupsNamespaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) + CreateRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) CreateRuleGroupsNamespaceRequest.struct_class = Types::CreateRuleGroupsNamespaceRequest - CreateRuleGroupsNamespaceResponse.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) CreateRuleGroupsNamespaceResponse.add_member(:arn, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceArn, required: true, location_name: "arn")) + CreateRuleGroupsNamespaceResponse.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) CreateRuleGroupsNamespaceResponse.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) CreateRuleGroupsNamespaceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) CreateRuleGroupsNamespaceResponse.struct_class = Types::CreateRuleGroupsNamespaceResponse CreateScraperRequest.add_member(:alias, Shapes::ShapeRef.new(shape: ScraperAlias, location_name: "alias")) + CreateScraperRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + CreateScraperRequest.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) CreateScraperRequest.add_member(:scrape_configuration, Shapes::ShapeRef.new(shape: ScrapeConfiguration, required: true, location_name: "scrapeConfiguration")) CreateScraperRequest.add_member(:source, Shapes::ShapeRef.new(shape: Source, required: true, location_name: "source")) - CreateScraperRequest.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) - CreateScraperRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) CreateScraperRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) CreateScraperRequest.struct_class = Types::CreateScraperRequest - CreateScraperResponse.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) CreateScraperResponse.add_member(:arn, Shapes::ShapeRef.new(shape: ScraperArn, required: true, location_name: "arn")) + CreateScraperResponse.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) CreateScraperResponse.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) CreateScraperResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) CreateScraperResponse.struct_class = Types::CreateScraperResponse CreateWorkspaceRequest.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location_name: "alias")) CreateWorkspaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) - CreateWorkspaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) CreateWorkspaceRequest.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn")) + CreateWorkspaceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) CreateWorkspaceRequest.struct_class = Types::CreateWorkspaceRequest - CreateWorkspaceResponse.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) CreateWorkspaceResponse.add_member(:arn, Shapes::ShapeRef.new(shape: WorkspaceArn, required: true, location_name: "arn")) + CreateWorkspaceResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn")) CreateWorkspaceResponse.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status")) CreateWorkspaceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) - CreateWorkspaceResponse.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn")) + CreateWorkspaceResponse.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) CreateWorkspaceResponse.struct_class = Types::CreateWorkspaceResponse - DeleteAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteAlertManagerDefinitionRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + DeleteAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteAlertManagerDefinitionRequest.struct_class = Types::DeleteAlertManagerDefinitionRequest - DeleteLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteLoggingConfigurationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + DeleteLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteLoggingConfigurationRequest.struct_class = Types::DeleteLoggingConfigurationRequest - DeleteRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - DeleteRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location: "uri", location_name: "name")) DeleteRuleGroupsNamespaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + DeleteRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location: "uri", location_name: "name")) + DeleteRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteRuleGroupsNamespaceRequest.struct_class = Types::DeleteRuleGroupsNamespaceRequest - DeleteScraperRequest.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location: "uri", location_name: "scraperId")) DeleteScraperRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + DeleteScraperRequest.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location: "uri", location_name: "scraperId")) DeleteScraperRequest.struct_class = Types::DeleteScraperRequest DeleteScraperResponse.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) DeleteScraperResponse.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) DeleteScraperResponse.struct_class = Types::DeleteScraperResponse - DeleteWorkspaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteWorkspaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location: "querystring", location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + DeleteWorkspaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DeleteWorkspaceRequest.struct_class = Types::DeleteWorkspaceRequest DescribeAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) @@ -248,8 +248,8 @@ module ClientApi DescribeLoggingConfigurationResponse.add_member(:logging_configuration, Shapes::ShapeRef.new(shape: LoggingConfigurationMetadata, required: true, location_name: "loggingConfiguration")) DescribeLoggingConfigurationResponse.struct_class = Types::DescribeLoggingConfigurationResponse - DescribeRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DescribeRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location: "uri", location_name: "name")) + DescribeRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) DescribeRuleGroupsNamespaceRequest.struct_class = Types::DescribeRuleGroupsNamespaceRequest DescribeRuleGroupsNamespaceResponse.add_member(:rule_groups_namespace, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceDescription, required: true, location_name: "ruleGroupsNamespace")) @@ -289,23 +289,23 @@ module ClientApi InternalServerException.add_member(:retry_after_seconds, Shapes::ShapeRef.new(shape: Integer, location: "header", location_name: "Retry-After")) InternalServerException.struct_class = Types::InternalServerException - ListRuleGroupsNamespacesRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) + ListRuleGroupsNamespacesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListRuleGroupsNamespacesRequestMaxResultsInteger, location: "querystring", location_name: "maxResults")) ListRuleGroupsNamespacesRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, location: "querystring", location_name: "name")) ListRuleGroupsNamespacesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) - ListRuleGroupsNamespacesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListRuleGroupsNamespacesRequestMaxResultsInteger, location: "querystring", location_name: "maxResults")) + ListRuleGroupsNamespacesRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) ListRuleGroupsNamespacesRequest.struct_class = Types::ListRuleGroupsNamespacesRequest - ListRuleGroupsNamespacesResponse.add_member(:rule_groups_namespaces, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceSummaryList, required: true, location_name: "ruleGroupsNamespaces")) ListRuleGroupsNamespacesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListRuleGroupsNamespacesResponse.add_member(:rule_groups_namespaces, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceSummaryList, required: true, location_name: "ruleGroupsNamespaces")) ListRuleGroupsNamespacesResponse.struct_class = Types::ListRuleGroupsNamespacesResponse ListScrapersRequest.add_member(:filters, Shapes::ShapeRef.new(shape: ScraperFilters, location: "querystring", location_name: "filters")) - ListScrapersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) ListScrapersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListScrapersRequestMaxResultsInteger, location: "querystring", location_name: "maxResults")) + ListScrapersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) ListScrapersRequest.struct_class = Types::ListScrapersRequest - ListScrapersResponse.add_member(:scrapers, Shapes::ShapeRef.new(shape: ScraperSummaryList, required: true, location_name: "scrapers")) ListScrapersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListScrapersResponse.add_member(:scrapers, Shapes::ShapeRef.new(shape: ScraperSummaryList, required: true, location_name: "scrapers")) ListScrapersResponse.struct_class = Types::ListScrapersResponse ListTagsForResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resourceArn")) @@ -314,42 +314,42 @@ module ClientApi ListTagsForResourceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) ListTagsForResourceResponse.struct_class = Types::ListTagsForResourceResponse - ListWorkspacesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) ListWorkspacesRequest.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location: "querystring", location_name: "alias")) ListWorkspacesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: ListWorkspacesRequestMaxResultsInteger, location: "querystring", location_name: "maxResults")) + ListWorkspacesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location: "querystring", location_name: "nextToken")) ListWorkspacesRequest.struct_class = Types::ListWorkspacesRequest - ListWorkspacesResponse.add_member(:workspaces, Shapes::ShapeRef.new(shape: WorkspaceSummaryList, required: true, location_name: "workspaces")) ListWorkspacesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken")) + ListWorkspacesResponse.add_member(:workspaces, Shapes::ShapeRef.new(shape: WorkspaceSummaryList, required: true, location_name: "workspaces")) ListWorkspacesResponse.struct_class = Types::ListWorkspacesResponse - LoggingConfigurationMetadata.add_member(:status, Shapes::ShapeRef.new(shape: LoggingConfigurationStatus, required: true, location_name: "status")) - LoggingConfigurationMetadata.add_member(:workspace, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspace")) - LoggingConfigurationMetadata.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) LoggingConfigurationMetadata.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + LoggingConfigurationMetadata.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) LoggingConfigurationMetadata.add_member(:modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "modifiedAt")) + LoggingConfigurationMetadata.add_member(:status, Shapes::ShapeRef.new(shape: LoggingConfigurationStatus, required: true, location_name: "status")) + LoggingConfigurationMetadata.add_member(:workspace, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspace")) LoggingConfigurationMetadata.struct_class = Types::LoggingConfigurationMetadata LoggingConfigurationStatus.add_member(:status_code, Shapes::ShapeRef.new(shape: LoggingConfigurationStatusCode, required: true, location_name: "statusCode")) LoggingConfigurationStatus.add_member(:status_reason, Shapes::ShapeRef.new(shape: String, location_name: "statusReason")) LoggingConfigurationStatus.struct_class = Types::LoggingConfigurationStatus - PutAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - PutAlertManagerDefinitionRequest.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) PutAlertManagerDefinitionRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + PutAlertManagerDefinitionRequest.add_member(:data, Shapes::ShapeRef.new(shape: AlertManagerDefinitionData, required: true, location_name: "data")) + PutAlertManagerDefinitionRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) PutAlertManagerDefinitionRequest.struct_class = Types::PutAlertManagerDefinitionRequest PutAlertManagerDefinitionResponse.add_member(:status, Shapes::ShapeRef.new(shape: AlertManagerDefinitionStatus, required: true, location_name: "status")) PutAlertManagerDefinitionResponse.struct_class = Types::PutAlertManagerDefinitionResponse - PutRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - PutRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location: "uri", location_name: "name")) - PutRuleGroupsNamespaceRequest.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) PutRuleGroupsNamespaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + PutRuleGroupsNamespaceRequest.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) + PutRuleGroupsNamespaceRequest.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location: "uri", location_name: "name")) + PutRuleGroupsNamespaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) PutRuleGroupsNamespaceRequest.struct_class = Types::PutRuleGroupsNamespaceRequest - PutRuleGroupsNamespaceResponse.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) PutRuleGroupsNamespaceResponse.add_member(:arn, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceArn, required: true, location_name: "arn")) + PutRuleGroupsNamespaceResponse.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) PutRuleGroupsNamespaceResponse.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) PutRuleGroupsNamespaceResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) PutRuleGroupsNamespaceResponse.struct_class = Types::PutRuleGroupsNamespaceResponse @@ -360,11 +360,11 @@ module ClientApi ResourceNotFoundException.struct_class = Types::ResourceNotFoundException RuleGroupsNamespaceDescription.add_member(:arn, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceArn, required: true, location_name: "arn")) - RuleGroupsNamespaceDescription.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) - RuleGroupsNamespaceDescription.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) - RuleGroupsNamespaceDescription.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) RuleGroupsNamespaceDescription.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + RuleGroupsNamespaceDescription.add_member(:data, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceData, required: true, location_name: "data")) RuleGroupsNamespaceDescription.add_member(:modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "modifiedAt")) + RuleGroupsNamespaceDescription.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) + RuleGroupsNamespaceDescription.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) RuleGroupsNamespaceDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) RuleGroupsNamespaceDescription.struct_class = Types::RuleGroupsNamespaceDescription @@ -373,10 +373,10 @@ module ClientApi RuleGroupsNamespaceStatus.struct_class = Types::RuleGroupsNamespaceStatus RuleGroupsNamespaceSummary.add_member(:arn, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceArn, required: true, location_name: "arn")) - RuleGroupsNamespaceSummary.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) - RuleGroupsNamespaceSummary.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) RuleGroupsNamespaceSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) RuleGroupsNamespaceSummary.add_member(:modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "modifiedAt")) + RuleGroupsNamespaceSummary.add_member(:name, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceName, required: true, location_name: "name")) + RuleGroupsNamespaceSummary.add_member(:status, Shapes::ShapeRef.new(shape: RuleGroupsNamespaceStatus, required: true, location_name: "status")) RuleGroupsNamespaceSummary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) RuleGroupsNamespaceSummary.struct_class = Types::RuleGroupsNamespaceSummary @@ -389,17 +389,17 @@ module ClientApi ScrapeConfiguration.struct_class = Types::ScrapeConfiguration ScraperDescription.add_member(:alias, Shapes::ShapeRef.new(shape: ScraperAlias, location_name: "alias")) - ScraperDescription.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) ScraperDescription.add_member(:arn, Shapes::ShapeRef.new(shape: ScraperArn, required: true, location_name: "arn")) - ScraperDescription.add_member(:role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "roleArn")) - ScraperDescription.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) ScraperDescription.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + ScraperDescription.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) ScraperDescription.add_member(:last_modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "lastModifiedAt")) - ScraperDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) - ScraperDescription.add_member(:status_reason, Shapes::ShapeRef.new(shape: StatusReason, location_name: "statusReason")) + ScraperDescription.add_member(:role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "roleArn")) ScraperDescription.add_member(:scrape_configuration, Shapes::ShapeRef.new(shape: ScrapeConfiguration, required: true, location_name: "scrapeConfiguration")) + ScraperDescription.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) ScraperDescription.add_member(:source, Shapes::ShapeRef.new(shape: Source, required: true, location_name: "source")) - ScraperDescription.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) + ScraperDescription.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) + ScraperDescription.add_member(:status_reason, Shapes::ShapeRef.new(shape: StatusReason, location_name: "statusReason")) + ScraperDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) ScraperDescription.struct_class = Types::ScraperDescription ScraperFilters.key = Shapes::ShapeRef.new(shape: FilterKey) @@ -409,16 +409,16 @@ module ClientApi ScraperStatus.struct_class = Types::ScraperStatus ScraperSummary.add_member(:alias, Shapes::ShapeRef.new(shape: ScraperAlias, location_name: "alias")) - ScraperSummary.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) ScraperSummary.add_member(:arn, Shapes::ShapeRef.new(shape: ScraperArn, required: true, location_name: "arn")) - ScraperSummary.add_member(:role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "roleArn")) - ScraperSummary.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) ScraperSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) + ScraperSummary.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) ScraperSummary.add_member(:last_modified_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "lastModifiedAt")) - ScraperSummary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) - ScraperSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: StatusReason, location_name: "statusReason")) + ScraperSummary.add_member(:role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "roleArn")) + ScraperSummary.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId")) ScraperSummary.add_member(:source, Shapes::ShapeRef.new(shape: Source, required: true, location_name: "source")) - ScraperSummary.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, required: true, location_name: "destination")) + ScraperSummary.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status")) + ScraperSummary.add_member(:status_reason, Shapes::ShapeRef.new(shape: StatusReason, location_name: "statusReason")) + ScraperSummary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) ScraperSummary.struct_class = Types::ScraperSummary ScraperSummaryList.member = Shapes::ShapeRef.new(shape: ScraperSummary) @@ -426,10 +426,10 @@ module ClientApi SecurityGroupIds.member = Shapes::ShapeRef.new(shape: SecurityGroupId) ServiceQuotaExceededException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message")) + ServiceQuotaExceededException.add_member(:quota_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "quotaCode")) ServiceQuotaExceededException.add_member(:resource_id, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceId")) ServiceQuotaExceededException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType")) ServiceQuotaExceededException.add_member(:service_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "serviceCode")) - ServiceQuotaExceededException.add_member(:quota_code, Shapes::ShapeRef.new(shape: String, required: true, location_name: "quotaCode")) ServiceQuotaExceededException.struct_class = Types::ServiceQuotaExceededException Source.add_member(:eks_configuration, Shapes::ShapeRef.new(shape: EksConfiguration, location_name: "eksConfiguration")) @@ -452,9 +452,9 @@ module ClientApi TagResourceResponse.struct_class = Types::TagResourceResponse ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message")) - ThrottlingException.add_member(:service_code, Shapes::ShapeRef.new(shape: String, location_name: "serviceCode")) ThrottlingException.add_member(:quota_code, Shapes::ShapeRef.new(shape: String, location_name: "quotaCode")) ThrottlingException.add_member(:retry_after_seconds, Shapes::ShapeRef.new(shape: Integer, location: "header", location_name: "Retry-After")) + ThrottlingException.add_member(:service_code, Shapes::ShapeRef.new(shape: String, location_name: "serviceCode")) ThrottlingException.struct_class = Types::ThrottlingException UntagResourceRequest.add_member(:resource_arn, Shapes::ShapeRef.new(shape: String, required: true, location: "uri", location_name: "resourceArn")) @@ -463,50 +463,50 @@ module ClientApi UntagResourceResponse.struct_class = Types::UntagResourceResponse - UpdateLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) - UpdateLoggingConfigurationRequest.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) UpdateLoggingConfigurationRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + UpdateLoggingConfigurationRequest.add_member(:log_group_arn, Shapes::ShapeRef.new(shape: LogGroupArn, required: true, location_name: "logGroupArn")) + UpdateLoggingConfigurationRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) UpdateLoggingConfigurationRequest.struct_class = Types::UpdateLoggingConfigurationRequest UpdateLoggingConfigurationResponse.add_member(:status, Shapes::ShapeRef.new(shape: LoggingConfigurationStatus, required: true, location_name: "status")) UpdateLoggingConfigurationResponse.struct_class = Types::UpdateLoggingConfigurationResponse - UpdateWorkspaceAliasRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) UpdateWorkspaceAliasRequest.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location_name: "alias")) UpdateWorkspaceAliasRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true})) + UpdateWorkspaceAliasRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId")) UpdateWorkspaceAliasRequest.struct_class = Types::UpdateWorkspaceAliasRequest + ValidationException.add_member(:field_list, Shapes::ShapeRef.new(shape: ValidationExceptionFieldList, location_name: "fieldList")) ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message")) ValidationException.add_member(:reason, Shapes::ShapeRef.new(shape: ValidationExceptionReason, required: true, location_name: "reason")) - ValidationException.add_member(:field_list, Shapes::ShapeRef.new(shape: ValidationExceptionFieldList, location_name: "fieldList")) ValidationException.struct_class = Types::ValidationException - ValidationExceptionField.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "name")) ValidationExceptionField.add_member(:message, Shapes::ShapeRef.new(shape: String, required: true, location_name: "message")) + ValidationExceptionField.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "name")) ValidationExceptionField.struct_class = Types::ValidationExceptionField ValidationExceptionFieldList.member = Shapes::ShapeRef.new(shape: ValidationExceptionField) - WorkspaceDescription.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) WorkspaceDescription.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location_name: "alias")) WorkspaceDescription.add_member(:arn, Shapes::ShapeRef.new(shape: WorkspaceArn, required: true, location_name: "arn")) - WorkspaceDescription.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status")) - WorkspaceDescription.add_member(:prometheus_endpoint, Shapes::ShapeRef.new(shape: Uri, location_name: "prometheusEndpoint")) WorkspaceDescription.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) - WorkspaceDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) WorkspaceDescription.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn")) + WorkspaceDescription.add_member(:prometheus_endpoint, Shapes::ShapeRef.new(shape: Uri, location_name: "prometheusEndpoint")) + WorkspaceDescription.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status")) + WorkspaceDescription.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) + WorkspaceDescription.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) WorkspaceDescription.struct_class = Types::WorkspaceDescription WorkspaceStatus.add_member(:status_code, Shapes::ShapeRef.new(shape: WorkspaceStatusCode, required: true, location_name: "statusCode")) WorkspaceStatus.struct_class = Types::WorkspaceStatus - WorkspaceSummary.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) WorkspaceSummary.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location_name: "alias")) WorkspaceSummary.add_member(:arn, Shapes::ShapeRef.new(shape: WorkspaceArn, required: true, location_name: "arn")) - WorkspaceSummary.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status")) WorkspaceSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "createdAt")) - WorkspaceSummary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) WorkspaceSummary.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "kmsKeyArn")) + WorkspaceSummary.add_member(:status, Shapes::ShapeRef.new(shape: WorkspaceStatus, required: true, location_name: "status")) + WorkspaceSummary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags")) + WorkspaceSummary.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId")) WorkspaceSummary.struct_class = Types::WorkspaceSummary WorkspaceSummaryList.member = Shapes::ShapeRef.new(shape: WorkspaceSummary) diff --git a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/errors.rb b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/errors.rb index 63618267c3f..5af55417ce9 100644 --- a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/errors.rb +++ b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/errors.rb @@ -144,6 +144,11 @@ def message @message || @data[:message] end + # @return [String] + def quota_code + @data[:quota_code] + end + # @return [String] def resource_id @data[:resource_id] @@ -158,11 +163,6 @@ def resource_type def service_code @data[:service_code] end - - # @return [String] - def quota_code - @data[:quota_code] - end end class ThrottlingException < ServiceError @@ -179,11 +179,6 @@ def message @message || @data[:message] end - # @return [String] - def service_code - @data[:service_code] - end - # @return [String] def quota_code @data[:quota_code] @@ -194,6 +189,11 @@ def retry_after_seconds @data[:retry_after_seconds] end + # @return [String] + def service_code + @data[:service_code] + end + def retryable? true end @@ -208,6 +208,11 @@ def initialize(context, message, data = Aws::EmptyStructure.new) super(context, message, data) end + # @return [String] + def field_list + @data[:field_list] + end + # @return [String] def message @message || @data[:message] @@ -217,11 +222,6 @@ def message def reason @data[:reason] end - - # @return [String] - def field_list - @data[:field_list] - end end end diff --git a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb index a833fa75c19..65988eaa2dc 100644 --- a/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb +++ b/gems/aws-sdk-prometheusservice/lib/aws-sdk-prometheusservice/types.rb @@ -10,7 +10,7 @@ module Aws::PrometheusService module Types - # User does not have sufficient access to perform this action. + # You do not have sufficient access to perform this action. # # @!attribute [rw] message # Description of the error. @@ -24,43 +24,52 @@ class AccessDeniedException < Struct.new( include Aws::Structure end - # Represents the properties of an alert manager definition. + # The details of an alert manager definition. # - # @!attribute [rw] status - # The status of alert manager definition. - # @return [Types::AlertManagerDefinitionStatus] + # @!attribute [rw] created_at + # The date and time that the alert manager definition was created. + # @return [Time] # # @!attribute [rw] data - # The alert manager definition. - # @return [String] + # The actual alert manager definition. # - # @!attribute [rw] created_at - # The time when the alert manager definition was created. - # @return [Time] + # For details about the alert manager definition, see + # [AlertManagedDefinitionData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html + # @return [String] # # @!attribute [rw] modified_at - # The time when the alert manager definition was modified. + # The date and time that the alert manager definition was most + # recently changed. # @return [Time] # + # @!attribute [rw] status + # A structure that displays the current status of the alert manager + # definition.. + # @return [Types::AlertManagerDefinitionStatus] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AlertManagerDefinitionDescription AWS API Documentation # class AlertManagerDefinitionDescription < Struct.new( - :status, - :data, :created_at, - :modified_at) + :data, + :modified_at, + :status) SENSITIVE = [] include Aws::Structure end - # Represents the status of a definition. + # The status of the alert manager. # # @!attribute [rw] status_code - # Status code of this definition. + # The current status of the alert manager. # @return [String] # # @!attribute [rw] status_reason - # The reason for failure if any. + # If there is a failure, the reason for the failure. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AlertManagerDefinitionStatus AWS API Documentation @@ -72,10 +81,11 @@ class AlertManagerDefinitionStatus < Struct.new( include Aws::Structure end - # A representation of an AMP destination. + # The `AmpConfiguration` structure defines the Amazon Managed Service + # for Prometheus instance a scraper should send metrics to. # # @!attribute [rw] workspace_arn - # The ARN of an AMP workspace. + # ARN of the Amazon Managed Service for Prometheus workspace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/AmpConfiguration AWS API Documentation @@ -86,7 +96,7 @@ class AmpConfiguration < Struct.new( include Aws::Structure end - # Updating or deleting a resource can cause an inconsistent state. + # The request would cause an inconsistent state. # # @!attribute [rw] message # Description of the error. @@ -110,39 +120,47 @@ class ConflictException < Struct.new( include Aws::Structure end - # Represents the input of a CreateAlertManagerDefinition operation. + # Represents the input of a `CreateAlertManagerDefinition` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace in which to create the alert manager - # definition. + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] data - # The alert manager definition data. - # @return [String] + # The alert manager definition to add. A base64-encoded version of the + # YAML alert manager definition file. # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # For details about the alert manager definition, see + # [AlertManagedDefinitionData][1]. # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html + # @return [String] + # + # @!attribute [rw] workspace_id + # The ID of the workspace to add the alert manager definition to. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAlertManagerDefinitionRequest AWS API Documentation # class CreateAlertManagerDefinitionRequest < Struct.new( - :workspace_id, + :client_token, :data, - :client_token) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a CreateAlertManagerDefinition operation. + # Represents the output of a `CreateAlertManagerDefinition` operation. # # @!attribute [rw] status - # The status of alert manager definition. + # A structure that displays the current status of the alert manager + # definition. # @return [Types::AlertManagerDefinitionStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAlertManagerDefinitionResponse AWS API Documentation @@ -153,39 +171,41 @@ class CreateAlertManagerDefinitionResponse < Struct.new( include Aws::Structure end - # Represents the input of a CreateLoggingConfiguration operation. + # Represents the input of a `CreateLoggingConfiguration` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace to vend logs to. + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] log_group_arn - # The ARN of the CW log group to which the vended log data will be - # published. + # The ARN of the CloudWatch log group to which the vended log data + # will be published. This log group must exist prior to calling this + # API. # @return [String] # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. - # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # @!attribute [rw] workspace_id + # The ID of the workspace to create the logging configuration for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateLoggingConfigurationRequest AWS API Documentation # class CreateLoggingConfigurationRequest < Struct.new( - :workspace_id, + :client_token, :log_group_arn, - :client_token) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a CreateLoggingConfiguration operation. + # Represents the output of a `CreateLoggingConfiguration` operation. # # @!attribute [rw] status - # The status of the logging configuration. + # A structure that displays the current status of the logging + # configuration. # @return [Types::LoggingConfigurationStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateLoggingConfigurationResponse AWS API Documentation @@ -196,323 +216,352 @@ class CreateLoggingConfigurationResponse < Struct.new( include Aws::Structure end - # Represents the input of a CreateRuleGroupsNamespace operation. + # Represents the input of a `CreateRuleGroupsNamespace` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace in which to create the rule group namespace. - # @return [String] + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # - # @!attribute [rw] name - # The rule groups namespace name. + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] data - # The namespace data that define the rule groups. - # @return [String] + # The rules file to use in the new namespace. # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # Contains the base64-encoded version of the YAML rules file. # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # For details about the rule groups namespace structure, see + # [RuleGroupsNamespaceData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html + # @return [String] + # + # @!attribute [rw] name + # The name for the new rule groups namespace. # @return [String] # # @!attribute [rw] tags - # Optional, user-provided tags for this rule groups namespace. + # The list of tag keys and values to associate with the rule groups + # namespace. # @return [Hash] # + # @!attribute [rw] workspace_id + # The ID of the workspace to add the rule groups namespace. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateRuleGroupsNamespaceRequest AWS API Documentation # class CreateRuleGroupsNamespaceRequest < Struct.new( - :workspace_id, - :name, - :data, :client_token, - :tags) + :data, + :name, + :tags, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a CreateRuleGroupsNamespace operation. + # Represents the output of a `CreateRuleGroupsNamespace` operation. # - # @!attribute [rw] name - # The rule groups namespace name. + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the new rule groups namespace. # @return [String] # - # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this rule groups namespace. + # @!attribute [rw] name + # The name of the new rule groups namespace. # @return [String] # # @!attribute [rw] status - # The status of rule groups namespace. + # A structure that returns the current status of the rule groups + # namespace. # @return [Types::RuleGroupsNamespaceStatus] # # @!attribute [rw] tags - # The tags of this rule groups namespace. + # The list of tag keys and values that are associated with the + # namespace. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateRuleGroupsNamespaceResponse AWS API Documentation # class CreateRuleGroupsNamespaceResponse < Struct.new( - :name, :arn, + :name, :status, :tags) SENSITIVE = [] include Aws::Structure end - # Represents the input of a CreateScraper operation. + # Represents the input of a `CreateScraper` operation. # # @!attribute [rw] alias - # An optional user-assigned alias for this scraper. This alias is for - # user reference and does not need to be unique. + # (optional) a name to associate with the scraper. This is for your + # use, and does not need to be unique. # @return [String] # - # @!attribute [rw] scrape_configuration - # The configuration used to create the scraper. - # @return [Types::ScrapeConfiguration] + # @!attribute [rw] client_token + # (Optional) A unique, case-sensitive identifier that you can provide + # to ensure the idempotency of the request. # - # @!attribute [rw] source - # The source that the scraper will be discovering and collecting - # metrics from. - # @return [Types::Source] + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. + # @return [String] # # @!attribute [rw] destination - # The destination that the scraper will be producing metrics to. + # The Amazon Managed Service for Prometheus workspace to send metrics + # to. # @return [Types::Destination] # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # @!attribute [rw] scrape_configuration + # The configuration file to use in the new scraper. For more + # information, see [Scraper + # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) + # in the *Amazon Managed Service for Prometheus User Guide*. + # @return [Types::ScrapeConfiguration] # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. - # @return [String] + # @!attribute [rw] source + # The Amazon EKS cluster from which the scraper will collect metrics. + # @return [Types::Source] # # @!attribute [rw] tags - # Optional, user-provided tags for this scraper. + # (Optional) The list of tag keys and values to associate with the + # scraper. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateScraperRequest AWS API Documentation # class CreateScraperRequest < Struct.new( :alias, + :client_token, + :destination, :scrape_configuration, :source, - :destination, - :client_token, :tags) SENSITIVE = [] include Aws::Structure end - # Represents the output of a CreateScraper operation. + # Represents the output of a `CreateScraper` operation. # - # @!attribute [rw] scraper_id - # The generated ID of the scraper that was just created. + # @!attribute [rw] arn + # The Amazon Resource Name (ARN) of the new scraper. # @return [String] # - # @!attribute [rw] arn - # The ARN of the scraper that was just created. + # @!attribute [rw] scraper_id + # The ID of the new scraper. # @return [String] # # @!attribute [rw] status - # The status of the scraper that was just created (usually CREATING). + # A structure that displays the current status of the scraper. # @return [Types::ScraperStatus] # # @!attribute [rw] tags - # The tags of this scraper. + # The list of tag keys and values that are associated with the + # scraper. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateScraperResponse AWS API Documentation # class CreateScraperResponse < Struct.new( - :scraper_id, :arn, + :scraper_id, :status, :tags) SENSITIVE = [] include Aws::Structure end - # Represents the input of a CreateWorkspace operation. + # Represents the input of a `CreateWorkspace` operation. # # @!attribute [rw] alias - # An optional user-assigned alias for this workspace. This alias is - # for user reference and does not need to be unique. + # An alias that you assign to this workspace to help you identify it. + # It does not need to be unique. + # + # Blank spaces at the beginning or end of the alias that you specify + # will be trimmed from the value used. # @return [String] # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # - # @!attribute [rw] tags - # Optional, user-provided tags for this workspace. - # @return [Hash] - # # @!attribute [rw] kms_key_arn - # Optional, customer managed KMS key used to encrypt data for this - # workspace + # (optional) The ARN for a customer managed KMS key to use for + # encrypting data within your workspace. For more information about + # using your own key in your workspace, see [Encryption at rest][1] in + # the *Amazon Managed Service for Prometheus User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html # @return [String] # + # @!attribute [rw] tags + # The list of tag keys and values to associate with the workspace. + # @return [Hash] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspaceRequest AWS API Documentation # class CreateWorkspaceRequest < Struct.new( :alias, :client_token, - :tags, - :kms_key_arn) + :kms_key_arn, + :tags) SENSITIVE = [] include Aws::Structure end - # Represents the output of a CreateWorkspace operation. + # Represents the output of a `CreateWorkspace` operation. # - # @!attribute [rw] workspace_id - # The generated ID of the workspace that was just created. + # @!attribute [rw] arn + # The ARN for the new workspace. # @return [String] # - # @!attribute [rw] arn - # The ARN of the workspace that was just created. + # @!attribute [rw] kms_key_arn + # (optional) If the workspace was created with a customer managed KMS + # key, the ARN for the key used. # @return [String] # # @!attribute [rw] status - # The status of the workspace that was just created (usually - # CREATING). + # The current status of the new workspace. Immediately after you + # create the workspace, the status is usually `CREATING`. # @return [Types::WorkspaceStatus] # # @!attribute [rw] tags - # The tags of this workspace. + # The list of tag keys and values that are associated with the + # workspace. # @return [Hash] # - # @!attribute [rw] kms_key_arn - # Customer managed KMS key ARN for this workspace + # @!attribute [rw] workspace_id + # The unique ID for the new workspace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspaceResponse AWS API Documentation # class CreateWorkspaceResponse < Struct.new( - :workspace_id, :arn, + :kms_key_arn, :status, :tags, - :kms_key_arn) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the input of a DeleteAlertManagerDefinition operation. - # - # @!attribute [rw] workspace_id - # The ID of the workspace in which to delete the alert manager - # definition. - # @return [String] + # Represents the input of a `DeleteAlertManagerDefinition` operation. # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # + # @!attribute [rw] workspace_id + # The ID of the workspace to delete the alert manager definition from. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinitionRequest AWS API Documentation # class DeleteAlertManagerDefinitionRequest < Struct.new( - :workspace_id, - :client_token) + :client_token, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the input of a DeleteLoggingConfiguration operation. - # - # @!attribute [rw] workspace_id - # The ID of the workspace to vend logs to. - # @return [String] + # Represents the input of a `DeleteLoggingConfiguration` operation. # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # + # @!attribute [rw] workspace_id + # The ID of the workspace containing the logging configuration to + # delete. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfigurationRequest AWS API Documentation # class DeleteLoggingConfigurationRequest < Struct.new( - :workspace_id, - :client_token) + :client_token, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the input of a DeleteRuleGroupsNamespace operation. + # Represents the input of a `DeleteRuleGroupsNamespace` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace to delete rule group definition. + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] name - # The rule groups namespace name. + # The name of the rule groups namespace to delete. # @return [String] # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. - # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # @!attribute [rw] workspace_id + # The ID of the workspace containing the rule groups namespace and + # definition to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespaceRequest AWS API Documentation # class DeleteRuleGroupsNamespaceRequest < Struct.new( - :workspace_id, + :client_token, :name, - :client_token) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the input of a DeleteScraper operation. - # - # @!attribute [rw] scraper_id - # The ID of the scraper to delete. - # @return [String] + # Represents the input of a `DeleteScraper` operation. # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # (Optional) A unique, case-sensitive identifier that you can provide + # to ensure the idempotency of the request. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # + # @!attribute [rw] scraper_id + # The ID of the scraper to delete. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraperRequest AWS API Documentation # class DeleteScraperRequest < Struct.new( - :scraper_id, - :client_token) + :client_token, + :scraper_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a DeleteScraper operation. + # Represents the output of a `DeleteScraper` operation. # # @!attribute [rw] scraper_id - # The ID of the scraper that was deleted. + # The ID of the scraper to delete. # @return [String] # # @!attribute [rw] status - # The status of the scraper that is being deleted. + # The current status of the scraper. # @return [Types::ScraperStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraperResponse AWS API Documentation @@ -524,33 +573,34 @@ class DeleteScraperResponse < Struct.new( include Aws::Structure end - # Represents the input of a DeleteWorkspace operation. - # - # @!attribute [rw] workspace_id - # The ID of the workspace to delete. - # @return [String] + # Represents the input of a `DeleteWorkspace` operation. # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # + # @!attribute [rw] workspace_id + # The ID of the workspace to delete. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspaceRequest AWS API Documentation # class DeleteWorkspaceRequest < Struct.new( - :workspace_id, - :client_token) + :client_token, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the input of a DescribeAlertManagerDefinition operation. + # Represents the input of a `DescribeAlertManagerDefinition` operation. # # @!attribute [rw] workspace_id - # The ID of the workspace to describe. + # The ID of the workspace to retrieve the alert manager definition + # from. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinitionRequest AWS API Documentation @@ -561,11 +611,10 @@ class DescribeAlertManagerDefinitionRequest < Struct.new( include Aws::Structure end - # Represents the output of a DescribeAlertManagerDefinition operation. + # Represents the output of a `DescribeAlertManagerDefinition` operation. # # @!attribute [rw] alert_manager_definition - # The properties of the selected workspace's alert manager - # definition. + # The alert manager definition. # @return [Types::AlertManagerDefinitionDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinitionResponse AWS API Documentation @@ -576,10 +625,10 @@ class DescribeAlertManagerDefinitionResponse < Struct.new( include Aws::Structure end - # Represents the input of a DescribeLoggingConfiguration operation. + # Represents the input of a `DescribeLoggingConfiguration` operation. # # @!attribute [rw] workspace_id - # The ID of the workspace to vend logs to. + # The ID of the workspace to describe the logging configuration for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfigurationRequest AWS API Documentation @@ -590,11 +639,11 @@ class DescribeLoggingConfigurationRequest < Struct.new( include Aws::Structure end - # Represents the output of a DescribeLoggingConfiguration operation. + # Represents the output of a `DescribeLoggingConfiguration` operation. # # @!attribute [rw] logging_configuration - # Metadata object containing information about the logging - # configuration of a workspace. + # A structure that displays the information about the logging + # configuration. # @return [Types::LoggingConfigurationMetadata] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfigurationResponse AWS API Documentation @@ -605,29 +654,29 @@ class DescribeLoggingConfigurationResponse < Struct.new( include Aws::Structure end - # Represents the input of a DescribeRuleGroupsNamespace operation. + # Represents the input of a `DescribeRuleGroupsNamespace` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace to describe. + # @!attribute [rw] name + # The name of the rule groups namespace that you want information for. # @return [String] # - # @!attribute [rw] name - # The rule groups namespace. + # @!attribute [rw] workspace_id + # The ID of the workspace containing the rule groups namespace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespaceRequest AWS API Documentation # class DescribeRuleGroupsNamespaceRequest < Struct.new( - :workspace_id, - :name) + :name, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a DescribeRuleGroupsNamespace operation. + # Represents the output of a `DescribeRuleGroupsNamespace` operation. # # @!attribute [rw] rule_groups_namespace - # The selected rule groups namespace. + # The information about the rule groups namespace. # @return [Types::RuleGroupsNamespaceDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespaceResponse AWS API Documentation @@ -638,10 +687,10 @@ class DescribeRuleGroupsNamespaceResponse < Struct.new( include Aws::Structure end - # Represents the input of a DescribeScraper operation. + # Represents the input of a `DescribeScraper` operation. # # @!attribute [rw] scraper_id - # The IDs of the scraper to describe. + # The ID of the scraper to describe. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeScraperRequest AWS API Documentation @@ -652,10 +701,10 @@ class DescribeScraperRequest < Struct.new( include Aws::Structure end - # Represents the output of a DescribeScraper operation. + # Represents the output of a `DescribeScraper` operation. # # @!attribute [rw] scraper - # The properties of the selected scrapers. + # Contains details about the scraper. # @return [Types::ScraperDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeScraperResponse AWS API Documentation @@ -666,7 +715,7 @@ class DescribeScraperResponse < Struct.new( include Aws::Structure end - # Represents the input of a DescribeWorkspace operation. + # Represents the input of a `DescribeWorkspace` operation. # # @!attribute [rw] workspace_id # The ID of the workspace to describe. @@ -680,10 +729,10 @@ class DescribeWorkspaceRequest < Struct.new( include Aws::Structure end - # Represents the output of a DescribeWorkspace operation. + # Represents the output of a `DescribeWorkspace` operation. # # @!attribute [rw] workspace - # The properties of the selected workspace. + # A structure that contains details about the workspace. # @return [Types::WorkspaceDescription] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspaceResponse AWS API Documentation @@ -694,15 +743,15 @@ class DescribeWorkspaceResponse < Struct.new( include Aws::Structure end - # A representation of a destination that a scraper can produce metrics - # to. + # Where to send the metrics from a scraper. # # @note Destination is a union - when making an API calls you must set exactly one of the members. # # @note Destination is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Destination corresponding to the set member. # # @!attribute [rw] amp_configuration - # A representation of an AMP destination. + # The Amazon Managed Service for Prometheusworkspace to send metrics + # to. # @return [Types::AmpConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/Destination AWS API Documentation @@ -718,18 +767,20 @@ class AmpConfiguration < Destination; end class Unknown < Destination; end end - # A representation of an EKS source. + # The `EksConfiguration` structure describes the connection to the + # Amazon EKS cluster from which a scraper collects metrics. # # @!attribute [rw] cluster_arn - # The ARN of an EKS cluster. + # ARN of the Amazon EKS cluster. # @return [String] # # @!attribute [rw] security_group_ids - # A list of security group IDs specified for VPC configuration. + # A list of the security group IDs for the Amazon EKS cluster VPC + # configuration. # @return [Array] # # @!attribute [rw] subnet_ids - # A list of subnet IDs specified for VPC configuration. + # A list of subnet IDs for the Amazon EKS cluster VPC configuration. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/EksConfiguration AWS API Documentation @@ -742,7 +793,7 @@ class EksConfiguration < Struct.new( include Aws::Structure end - # Represents the input of a GetDefaultScraperConfiguration operation. + # Represents the input of a `GetDefaultScraperConfiguration` operation. # # @api private # @@ -750,10 +801,16 @@ class EksConfiguration < Struct.new( # class GetDefaultScraperConfigurationRequest < Aws::EmptyStructure; end - # Represents the output of a GetDefaultScraperConfiguration operation. + # Represents the output of a `GetDefaultScraperConfiguration` operation. # # @!attribute [rw] configuration - # The default configuration. + # The configuration file. Base 64 encoded. For more information, see + # [Scraper configuration][1]in the *Amazon Managed Service for + # Prometheus User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/GetDefaultScraperConfigurationResponse AWS API Documentation @@ -764,7 +821,7 @@ class GetDefaultScraperConfigurationResponse < Struct.new( include Aws::Structure end - # Unexpected error during processing of request. + # An unexpected error occurred during the processing of the request. # # @!attribute [rw] message # Description of the error. @@ -783,105 +840,135 @@ class InternalServerException < Struct.new( include Aws::Structure end - # Represents the input of a ListRuleGroupsNamespaces operation. + # Represents the input of a `ListRuleGroupsNamespaces` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace. - # @return [String] + # @!attribute [rw] max_results + # The maximum number of results to return. The default is 100. + # @return [Integer] # # @!attribute [rw] name - # Optional filter for rule groups namespace name. Only the rule groups - # namespace that begin with this value will be returned. + # Use this parameter to filter the rule groups namespaces that are + # returned. Only the namespaces with names that begin with the value + # that you specify are returned. # @return [String] # # @!attribute [rw] next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous - # ListRuleGroupsNamespaces request. + # The token for the next set of items to return. You receive this + # token from a previous call, and use it to get the next page of + # results. The other parameters must be the same as the initial call. + # + # For example, if your initial request has `maxResults` of 10, and + # there are 12 rule groups namespaces to return, then your initial + # request will return 10 and a `nextToken`. Using the next token in a + # subsequent call will return the remaining 2 namespaces. # @return [String] # - # @!attribute [rw] max_results - # Maximum results to return in response (default=100, maximum=1000). - # @return [Integer] + # @!attribute [rw] workspace_id + # The ID of the workspace containing the rule groups namespaces. + # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespacesRequest AWS API Documentation # class ListRuleGroupsNamespacesRequest < Struct.new( - :workspace_id, + :max_results, :name, :next_token, - :max_results) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a ListRuleGroupsNamespaces operation. - # - # @!attribute [rw] rule_groups_namespaces - # The list of the selected rule groups namespaces. - # @return [Array] + # Represents the output of a `ListRuleGroupsNamespaces` operation. # # @!attribute [rw] next_token - # Pagination token to use when requesting the next page in this list. + # A token indicating that there are more results to retrieve. You can + # use this token as part of your next `ListRuleGroupsNamespaces` + # request to retrieve those results. # @return [String] # + # @!attribute [rw] rule_groups_namespaces + # The returned list of rule groups namespaces. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespacesResponse AWS API Documentation # class ListRuleGroupsNamespacesResponse < Struct.new( - :rule_groups_namespaces, - :next_token) + :next_token, + :rule_groups_namespaces) SENSITIVE = [] include Aws::Structure end - # Represents the input of a ListScrapers operation. + # Represents the input of a `ListScrapers` operation. # # @!attribute [rw] filters - # A list of scraper filters. - # @return [Hash>] + # (Optional) A list of key-value pairs to filter the list of scrapers + # returned. Keys include `status`, `sourceArn`, `destinationArn`, and + # `alias`. # - # @!attribute [rw] next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous ListScrapers - # request. - # @return [String] + # Filters on the same key are `OR`'d together, and filters on + # different keys are `AND`'d together. For example, + # `status=ACTIVE&status=CREATING&alias=Test`, will return all scrapers + # that have the alias Test, and are either in status ACTIVE or + # CREATING. + # + # To find all active scrapers that are sending metrics to a specific + # Amazon Managed Service for Prometheus workspace, you would use the + # ARN of the workspace in a query: + # + # `status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012` + # + # If this is included, it filters the results to only the scrapers + # that match the filter. + # @return [Hash>] # # @!attribute [rw] max_results - # Maximum results to return in response (default=100, maximum=1000). + # Optional) The maximum number of scrapers to return in one + # `ListScrapers` operation. The range is 1-1000. + # + # If you omit this parameter, the default of 100 is used. # @return [Integer] # + # @!attribute [rw] next_token + # (Optional) The token for the next set of items to return. (You + # received this token from a previous call.) + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapersRequest AWS API Documentation # class ListScrapersRequest < Struct.new( :filters, - :next_token, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # Represents the output of a ListScrapers operation. - # - # @!attribute [rw] scrapers - # The list of scrapers, filtered down if a set of filters was provided - # in the request. - # @return [Array] + # Represents the output of a `ListScrapers` operation. # # @!attribute [rw] next_token - # Pagination token to use when requesting the next page in this list. + # A token indicating that there are more results to retrieve. You can + # use this token as part of your next `ListScrapers` operation to + # retrieve those results. # @return [String] # + # @!attribute [rw] scrapers + # A list of `ScraperSummary` structures giving information about + # scrapers in the account that match the filters provided. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapersResponse AWS API Documentation # class ListScrapersResponse < Struct.new( - :scrapers, - :next_token) + :next_token, + :scrapers) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn - # The ARN of the resource. + # The ARN of the resource to list tages for. Must be a workspace or + # rule groups namespace resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResourceRequest AWS API Documentation @@ -893,7 +980,7 @@ class ListTagsForResourceRequest < Struct.new( end # @!attribute [rw] tags - # The list of tags assigned to the resource. + # The list of tag keys and values associated with the resource. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResourceResponse AWS API Documentation @@ -904,96 +991,109 @@ class ListTagsForResourceResponse < Struct.new( include Aws::Structure end - # Represents the input of a ListWorkspaces operation. - # - # @!attribute [rw] next_token - # Pagination token to request the next page in a paginated list. This - # token is obtained from the output of the previous ListWorkspaces - # request. - # @return [String] + # Represents the input of a `ListWorkspaces` operation. # # @!attribute [rw] alias - # Optional filter for workspace alias. Only the workspaces with - # aliases that begin with this value will be returned. + # If this is included, it filters the results to only the workspaces + # with names that start with the value that you specify here. + # + # Amazon Managed Service for Prometheus will automatically strip any + # blank spaces from the beginning and end of the alias that you + # specify. # @return [String] # # @!attribute [rw] max_results - # Maximum results to return in response (default=100, maximum=1000). + # The maximum number of workspaces to return per request. The default + # is 100. # @return [Integer] # + # @!attribute [rw] next_token + # The token for the next set of items to return. You receive this + # token from a previous call, and use it to get the next page of + # results. The other parameters must be the same as the initial call. + # + # For example, if your initial request has `maxResults` of 10, and + # there are 12 workspaces to return, then your initial request will + # return 10 and a `nextToken`. Using the next token in a subsequent + # call will return the remaining 2 workspaces. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspacesRequest AWS API Documentation # class ListWorkspacesRequest < Struct.new( - :next_token, :alias, - :max_results) + :max_results, + :next_token) SENSITIVE = [] include Aws::Structure end - # Represents the output of a ListWorkspaces operation. - # - # @!attribute [rw] workspaces - # The list of existing workspaces, including those undergoing creation - # or deletion. - # @return [Array] + # Represents the output of a `ListWorkspaces` operation. # # @!attribute [rw] next_token - # Pagination token to use when requesting the next page in this list. + # A token indicating that there are more results to retrieve. You can + # use this token as part of your next `ListWorkspaces` request to + # retrieve those results. # @return [String] # + # @!attribute [rw] workspaces + # An array of `WorkspaceSummary` structures containing information + # about the workspaces requested. + # @return [Array] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspacesResponse AWS API Documentation # class ListWorkspacesResponse < Struct.new( - :workspaces, - :next_token) + :next_token, + :workspaces) SENSITIVE = [] include Aws::Structure end - # Represents the properties of a logging configuration metadata. + # Contains information about the logging configuration. # - # @!attribute [rw] status - # The status of the logging configuration. - # @return [Types::LoggingConfigurationStatus] + # @!attribute [rw] created_at + # The date and time that the logging configuration was created. + # @return [Time] # - # @!attribute [rw] workspace - # The workspace where the logging configuration exists. + # @!attribute [rw] log_group_arn + # The ARN of the CloudWatch log group to which the vended log data + # will be published. # @return [String] # - # @!attribute [rw] log_group_arn - # The ARN of the CW log group to which the vended log data will be - # published. - # @return [String] - # - # @!attribute [rw] created_at - # The time when the logging configuration was created. - # @return [Time] - # # @!attribute [rw] modified_at - # The time when the logging configuration was modified. + # The date and time that the logging configuration was most recently + # changed. # @return [Time] # + # @!attribute [rw] status + # The current status of the logging configuration. + # @return [Types::LoggingConfigurationStatus] + # + # @!attribute [rw] workspace + # The ID of the workspace the logging configuration is for. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/LoggingConfigurationMetadata AWS API Documentation # class LoggingConfigurationMetadata < Struct.new( - :status, - :workspace, - :log_group_arn, :created_at, - :modified_at) + :log_group_arn, + :modified_at, + :status, + :workspace) SENSITIVE = [] include Aws::Structure end - # Represents the status of a logging configuration. + # The status of the logging configuration. # # @!attribute [rw] status_code - # Status code of the logging configuration. + # The current status of the logging configuration. # @return [String] # # @!attribute [rw] status_reason - # The reason for failure if any. + # If failed, the reason for the failure. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/LoggingConfigurationStatus AWS API Documentation @@ -1005,39 +1105,47 @@ class LoggingConfigurationStatus < Struct.new( include Aws::Structure end - # Represents the input of a PutAlertManagerDefinition operation. + # Represents the input of a `PutAlertManagerDefinition` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace in which to update the alert manager - # definition. + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] data - # The alert manager definition data. - # @return [String] + # The alert manager definition to use. A base64-encoded version of the + # YAML alert manager definition file. # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # For details about the alert manager definition, see + # [AlertManagedDefinitionData][1]. # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html + # @return [String] + # + # @!attribute [rw] workspace_id + # The ID of the workspace to update the alert manager definition in. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAlertManagerDefinitionRequest AWS API Documentation # class PutAlertManagerDefinitionRequest < Struct.new( - :workspace_id, + :client_token, :data, - :client_token) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a PutAlertManagerDefinition operation. + # Represents the output of a `PutAlertManagerDefinition` operation. # # @!attribute [rw] status - # The status of alert manager definition. + # A structure that returns the current status of the alert manager + # definition. # @return [Types::AlertManagerDefinitionStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAlertManagerDefinitionResponse AWS API Documentation @@ -1048,69 +1156,80 @@ class PutAlertManagerDefinitionResponse < Struct.new( include Aws::Structure end - # Represents the input of a PutRuleGroupsNamespace operation. + # Represents the input of a `PutRuleGroupsNamespace` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace in which to update the rule group namespace. - # @return [String] + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # - # @!attribute [rw] name - # The rule groups namespace name. + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] data - # The namespace data that define the rule groups. + # The new rules file to use in the namespace. A base64-encoded version + # of the YAML rule groups file. + # + # For details about the rule groups namespace structure, see + # [RuleGroupsNamespaceData][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html # @return [String] # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # @!attribute [rw] name + # The name of the rule groups namespace that you are updating. + # @return [String] # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # @!attribute [rw] workspace_id + # The ID of the workspace where you are updating the rule groups + # namespace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutRuleGroupsNamespaceRequest AWS API Documentation # class PutRuleGroupsNamespaceRequest < Struct.new( - :workspace_id, - :name, + :client_token, :data, - :client_token) + :name, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of a PutRuleGroupsNamespace operation. + # Represents the output of a `PutRuleGroupsNamespace` operation. # - # @!attribute [rw] name - # The rule groups namespace name. + # @!attribute [rw] arn + # The ARN of the rule groups namespace. # @return [String] # - # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this rule groups namespace. + # @!attribute [rw] name + # The name of the rule groups namespace that was updated. # @return [String] # # @!attribute [rw] status - # The status of rule groups namespace. + # A structure that includes the current status of the rule groups + # namespace. # @return [Types::RuleGroupsNamespaceStatus] # # @!attribute [rw] tags - # The tags of this rule groups namespace. + # The list of tag keys and values that are associated with the + # namespace. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutRuleGroupsNamespaceResponse AWS API Documentation # class PutRuleGroupsNamespaceResponse < Struct.new( - :name, :arn, + :name, :status, :tags) SENSITIVE = [] include Aws::Structure end - # Request references a resource which does not exist. + # The request references a resources that doesn't exist. # # @!attribute [rw] message # Description of the error. @@ -1134,58 +1253,67 @@ class ResourceNotFoundException < Struct.new( include Aws::Structure end - # Represents a description of the rule groups namespace. + # The details about one rule groups namespace. # # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this rule groups namespace. + # The ARN of the rule groups namespace. # @return [String] # - # @!attribute [rw] name - # The rule groups namespace name. - # @return [String] - # - # @!attribute [rw] status - # The status of rule groups namespace. - # @return [Types::RuleGroupsNamespaceStatus] + # @!attribute [rw] created_at + # The date and time that the rule groups namespace was created. + # @return [Time] # # @!attribute [rw] data - # The rule groups namespace data. - # @return [String] + # The rule groups file used in the namespace. + # + # For details about the rule groups namespace structure, see + # [RuleGroupsNamespaceData][1]. # - # @!attribute [rw] created_at - # The time when the rule groups namespace was created. - # @return [Time] + # + # + # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html + # @return [String] # # @!attribute [rw] modified_at - # The time when the rule groups namespace was modified. + # The date and time that the rule groups namespace was most recently + # changed. # @return [Time] # + # @!attribute [rw] name + # The name of the rule groups namespace. + # @return [String] + # + # @!attribute [rw] status + # The current status of the rule groups namespace. + # @return [Types::RuleGroupsNamespaceStatus] + # # @!attribute [rw] tags - # The tags of this rule groups namespace. + # The list of tag keys and values that are associated with the rule + # groups namespace. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceDescription AWS API Documentation # class RuleGroupsNamespaceDescription < Struct.new( :arn, - :name, - :status, - :data, :created_at, + :data, :modified_at, + :name, + :status, :tags) SENSITIVE = [] include Aws::Structure end - # Represents the status of a namespace. + # The status information about a rule groups namespace. # # @!attribute [rw] status_code - # Status code of this namespace. + # The current status of the namespace. # @return [String] # # @!attribute [rw] status_reason - # The reason for failure if any. + # The reason for the failure, if any. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceStatus AWS API Documentation @@ -1197,53 +1325,60 @@ class RuleGroupsNamespaceStatus < Struct.new( include Aws::Structure end - # Represents a summary of the rule groups namespace. + # The high-level information about a rule groups namespace. To retrieve + # more information, use `DescribeRuleGroupsNamespace`. # # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this rule groups namespace. + # The ARN of the rule groups namespace. # @return [String] # - # @!attribute [rw] name - # The rule groups namespace name. - # @return [String] - # - # @!attribute [rw] status - # The status of rule groups namespace. - # @return [Types::RuleGroupsNamespaceStatus] - # # @!attribute [rw] created_at - # The time when the rule groups namespace was created. + # The date and time that the rule groups namespace was created. # @return [Time] # # @!attribute [rw] modified_at - # The time when the rule groups namespace was modified. + # The date and time that the rule groups namespace was most recently + # changed. # @return [Time] # + # @!attribute [rw] name + # The name of the rule groups namespace. + # @return [String] + # + # @!attribute [rw] status + # A structure that displays the current status of the rule groups + # namespace. + # @return [Types::RuleGroupsNamespaceStatus] + # # @!attribute [rw] tags - # The tags of this rule groups namespace. + # The list of tag keys and values that are associated with the rule + # groups namespace. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/RuleGroupsNamespaceSummary AWS API Documentation # class RuleGroupsNamespaceSummary < Struct.new( :arn, - :name, - :status, :created_at, :modified_at, + :name, + :status, :tags) SENSITIVE = [] include Aws::Structure end - # A representation of a Prometheus configuration file. + # A scrape configuration for a scraper, base 64 encoded. For more + # information, see [Scraper + # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration) + # in the *Amazon Managed Service for Prometheus User Guide*. # # @note ScrapeConfiguration is a union - when making an API calls you must set exactly one of the members. # # @note ScrapeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ScrapeConfiguration corresponding to the set member. # # @!attribute [rw] configuration_blob - # Binary data representing a Prometheus configuration file. + # The base 64 encoded scrape configuration file. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScrapeConfiguration AWS API Documentation @@ -1259,82 +1394,85 @@ class ConfigurationBlob < ScrapeConfiguration; end class Unknown < ScrapeConfiguration; end end - # Represents the properties of a scraper. + # The `ScraperDescription` structure contains the full details about one + # scraper in your account. # # @!attribute [rw] alias - # Alias of this scraper. - # @return [String] - # - # @!attribute [rw] scraper_id - # Unique string identifying this scraper. + # (Optional) A name associated with the scraper. # @return [String] # # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this scraper. + # The Amazon Resource Name (ARN) of the scraper. # @return [String] # - # @!attribute [rw] role_arn - # The Amazon Resource Name (ARN) of the IAM role that provides - # permissions for the scraper to dsicover, collect, and produce - # metrics on your behalf. - # @return [String] - # - # @!attribute [rw] status - # The status of this scraper. - # @return [Types::ScraperStatus] - # # @!attribute [rw] created_at - # The time when the scraper was created. + # The date and time that the scraper was created. # @return [Time] # + # @!attribute [rw] destination + # The Amazon Managed Service for Prometheus workspace the scraper + # sends metrics to. + # @return [Types::Destination] + # # @!attribute [rw] last_modified_at - # The time when the scraper was last modified. + # The date and time that the scraper was last modified. # @return [Time] # - # @!attribute [rw] tags - # The tags of this scraper. - # @return [Hash] - # - # @!attribute [rw] status_reason - # The reason for failure if any. + # @!attribute [rw] role_arn + # The Amazon Resource Name (ARN) of the IAM role that provides + # permissions for the scraper to discover and collect metrics on your + # behalf. # @return [String] # # @!attribute [rw] scrape_configuration - # The configuration used to create the scraper. + # The configuration file in use by the scraper. # @return [Types::ScrapeConfiguration] # + # @!attribute [rw] scraper_id + # The ID of the scraper. + # @return [String] + # # @!attribute [rw] source - # The source that the scraper is discovering and collecting metrics - # from. + # The Amazon EKS cluster from which the scraper collects metrics. # @return [Types::Source] # - # @!attribute [rw] destination - # The destination that the scraper is producing metrics to. - # @return [Types::Destination] + # @!attribute [rw] status + # A structure that contains the current status of the scraper. + # @return [Types::ScraperStatus] + # + # @!attribute [rw] status_reason + # If there is a failure, the reason for the failure. + # @return [String] + # + # @!attribute [rw] tags + # (Optional) The list of tag keys and values associated with the + # scraper. + # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperDescription AWS API Documentation # class ScraperDescription < Struct.new( :alias, - :scraper_id, :arn, - :role_arn, - :status, :created_at, + :destination, :last_modified_at, - :tags, - :status_reason, + :role_arn, :scrape_configuration, + :scraper_id, :source, - :destination) + :status, + :status_reason, + :tags) SENSITIVE = [] include Aws::Structure end - # Represents the status of a scraper. + # The `ScraperStatus` structure contains status information about the + # scraper. # # @!attribute [rw] status_code - # Status code of this scraper. + # The current status of the scraper. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperStatus AWS API Documentation @@ -1345,79 +1483,85 @@ class ScraperStatus < Struct.new( include Aws::Structure end - # Represents a summary of the properties of a scraper. + # The `ScraperSummary` structure contains a summary of the details about + # one scraper in your account. # # @!attribute [rw] alias - # Alias of this scraper. - # @return [String] - # - # @!attribute [rw] scraper_id - # Unique string identifying this scraper. + # (Optional) A name associated with the scraper. # @return [String] # # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this scraper. + # The Amazon Resource Name (ARN) of the scraper. # @return [String] # - # @!attribute [rw] role_arn - # The Amazon Resource Name (ARN) of the IAM role that provides - # permissions for the scraper to dsicover, collect, and produce - # metrics on your behalf. - # @return [String] - # - # @!attribute [rw] status - # The status of this scraper. - # @return [Types::ScraperStatus] - # # @!attribute [rw] created_at - # The time when the scraper was created. + # The date and time that the scraper was created. # @return [Time] # + # @!attribute [rw] destination + # The Amazon Managed Service for Prometheus workspace the scraper + # sends metrics to. + # @return [Types::Destination] + # # @!attribute [rw] last_modified_at - # The time when the scraper was last modified. + # The date and time that the scraper was last modified. # @return [Time] # - # @!attribute [rw] tags - # The tags of this scraper. - # @return [Hash] + # @!attribute [rw] role_arn + # The Amazon Resource Name (ARN) of the IAM role that provides + # permissions for the scraper to discover and collect metrics on your + # behalf. + # @return [String] # - # @!attribute [rw] status_reason - # The reason for failure if any. + # @!attribute [rw] scraper_id + # The ID of the scraper. # @return [String] # # @!attribute [rw] source - # The source that the scraper is discovering and collecting metrics - # from. + # The Amazon EKS cluster from which the scraper collects metrics. # @return [Types::Source] # - # @!attribute [rw] destination - # The destination that the scraper is producing metrics to. - # @return [Types::Destination] + # @!attribute [rw] status + # A structure that contains the current status of the scraper. + # @return [Types::ScraperStatus] + # + # @!attribute [rw] status_reason + # If there is a failure, the reason for the failure. + # @return [String] + # + # @!attribute [rw] tags + # (Optional) The list of tag keys and values associated with the + # scraper. + # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ScraperSummary AWS API Documentation # class ScraperSummary < Struct.new( :alias, - :scraper_id, :arn, - :role_arn, - :status, :created_at, + :destination, :last_modified_at, - :tags, - :status_reason, + :role_arn, + :scraper_id, :source, - :destination) + :status, + :status_reason, + :tags) SENSITIVE = [] include Aws::Structure end - # Request would cause a service quota to be exceeded. + # Completing the request would cause a service quota to be exceeded. # # @!attribute [rw] message # Description of the error. # @return [String] # + # @!attribute [rw] quota_code + # Service quotas code of the originating quota. + # @return [String] + # # @!attribute [rw] resource_id # Identifier of the resource affected. # @return [String] @@ -1427,34 +1571,29 @@ class ScraperSummary < Struct.new( # @return [String] # # @!attribute [rw] service_code - # Service Quotas requirement to identify originating service. - # @return [String] - # - # @!attribute [rw] quota_code - # Service Quotas requirement to identify originating quota. + # Service quotas code for the originating service. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message, + :quota_code, :resource_id, :resource_type, - :service_code, - :quota_code) + :service_code) SENSITIVE = [] include Aws::Structure end - # A representation of a source that a scraper can discover and collect - # metrics from. + # The source of collected metrics for a scraper. # # @note Source is a union - when making an API calls you must set exactly one of the members. # # @note Source is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Source corresponding to the set member. # # @!attribute [rw] eks_configuration - # A representation of an EKS source. + # The Amazon EKS cluster from which a scraper collects metrics. # @return [Types::EksConfiguration] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/Source AWS API Documentation @@ -1471,11 +1610,13 @@ class Unknown < Source; end end # @!attribute [rw] resource_arn - # The ARN of the resource. + # The ARN of the workspace or rule groups namespace to apply tags to. # @return [String] # # @!attribute [rw] tags - # The list of tags assigned to the resource. + # The list of tag keys and values to associate with the resource. + # + # Keys may not begin with `aws:`. # @return [Hash] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/TagResourceRequest AWS API Documentation @@ -1491,41 +1632,41 @@ class TagResourceRequest < Struct.new( # class TagResourceResponse < Aws::EmptyStructure; end - # Request was denied due to request throttling. + # The request was denied due to request throttling. # # @!attribute [rw] message # Description of the error. # @return [String] # - # @!attribute [rw] service_code - # Service Quotas requirement to identify originating service. - # @return [String] - # # @!attribute [rw] quota_code - # Service Quotas requirement to identify originating quota. + # Service quotas code for the originating quota. # @return [String] # # @!attribute [rw] retry_after_seconds # Advice to clients on when the call can be safely retried. # @return [Integer] # + # @!attribute [rw] service_code + # Service quotas code for the originating service. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :message, - :service_code, :quota_code, - :retry_after_seconds) + :retry_after_seconds, + :service_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn - # The ARN of the resource. + # The ARN of the workspace or rule groups namespace. # @return [String] # # @!attribute [rw] tag_keys - # One or more tag keys + # The keys of the tags to remove. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UntagResourceRequest AWS API Documentation @@ -1541,39 +1682,40 @@ class UntagResourceRequest < Struct.new( # class UntagResourceResponse < Aws::EmptyStructure; end - # Represents the input of an UpdateLoggingConfiguration operation. + # Represents the input of an `UpdateLoggingConfiguration` operation. # - # @!attribute [rw] workspace_id - # The ID of the workspace to vend logs to. + # @!attribute [rw] client_token + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. + # + # **A suitable default value is auto-generated.** You should normally + # not need to pass this option. # @return [String] # # @!attribute [rw] log_group_arn - # The ARN of the CW log group to which the vended log data will be - # published. + # The ARN of the CloudWatch log group to which the vended log data + # will be published. # @return [String] # - # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. - # - # **A suitable default value is auto-generated.** You should normally - # not need to pass this option. + # @!attribute [rw] workspace_id + # The ID of the workspace to update the logging configuration for. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateLoggingConfigurationRequest AWS API Documentation # class UpdateLoggingConfigurationRequest < Struct.new( - :workspace_id, + :client_token, :log_group_arn, - :client_token) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the output of an UpdateLoggingConfiguration operation. + # Represents the output of an `UpdateLoggingConfiguration` operation. # # @!attribute [rw] status - # The status of the logging configuration. + # A structure that contains the current status of the logging + # configuration. # @return [Types::LoggingConfigurationStatus] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateLoggingConfigurationResponse AWS API Documentation @@ -1584,36 +1726,44 @@ class UpdateLoggingConfigurationResponse < Struct.new( include Aws::Structure end - # Represents the input of an UpdateWorkspaceAlias operation. - # - # @!attribute [rw] workspace_id - # The ID of the workspace being updated. - # @return [String] + # Represents the input of an `UpdateWorkspaceAlias` operation. # # @!attribute [rw] alias - # The new alias of the workspace. + # The new alias for the workspace. It does not need to be unique. + # + # Amazon Managed Service for Prometheus will automatically strip any + # blank spaces from the beginning and end of the alias that you + # specify. # @return [String] # # @!attribute [rw] client_token - # Optional, unique, case-sensitive, user-provided identifier to ensure - # the idempotency of the request. + # A unique identifier that you can provide to ensure the idempotency + # of the request. Case-sensitive. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # + # @!attribute [rw] workspace_id + # The ID of the workspace to update. + # @return [String] + # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAliasRequest AWS API Documentation # class UpdateWorkspaceAliasRequest < Struct.new( - :workspace_id, :alias, - :client_token) + :client_token, + :workspace_id) SENSITIVE = [] include Aws::Structure end - # The input fails to satisfy the constraints specified by an AWS - # service. + # The input fails to satisfy the constraints specified by an Amazon Web + # Services service. + # + # @!attribute [rw] field_list + # The field that caused the error, if applicable. + # @return [Array] # # @!attribute [rw] message # Description of the error. @@ -1623,94 +1773,93 @@ class UpdateWorkspaceAliasRequest < Struct.new( # Reason the request failed validation. # @return [String] # - # @!attribute [rw] field_list - # The field that caused the error, if applicable. If more than one - # field caused the error, pick one and elaborate in the message. - # @return [Array] - # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ValidationException AWS API Documentation # class ValidationException < Struct.new( + :field_list, :message, - :reason, - :field_list) + :reason) SENSITIVE = [] include Aws::Structure end - # Stores information about a field passed inside a request that resulted - # in an exception. + # Information about a field passed into a request that resulted in an + # exception. # - # @!attribute [rw] name - # The field name. + # @!attribute [rw] message + # A message describing why the field caused an exception. # @return [String] # - # @!attribute [rw] message - # Message describing why the field failed validation. + # @!attribute [rw] name + # The name of the field that caused an exception. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ValidationExceptionField AWS API Documentation # class ValidationExceptionField < Struct.new( - :name, - :message) + :message, + :name) SENSITIVE = [] include Aws::Structure end - # Represents the properties of a workspace. - # - # @!attribute [rw] workspace_id - # Unique string identifying this workspace. - # @return [String] + # The full details about one Amazon Managed Service for Prometheus + # workspace in your account. # # @!attribute [rw] alias - # Alias of this workspace. + # The alias that is assigned to this workspace to help identify it. It + # may not be unique. # @return [String] # # @!attribute [rw] arn - # The Amazon Resource Name (ARN) of this workspace. + # The ARN of the workspace. # @return [String] # - # @!attribute [rw] status - # The status of this workspace. - # @return [Types::WorkspaceStatus] + # @!attribute [rw] created_at + # The date and time that the workspace was created. + # @return [Time] + # + # @!attribute [rw] kms_key_arn + # (optional) If the workspace was created with a customer managed KMS + # key, the ARN for the key used. + # @return [String] # # @!attribute [rw] prometheus_endpoint - # Prometheus endpoint URI. + # The Prometheus endpoint available for this workspace. # @return [String] # - # @!attribute [rw] created_at - # The time when the workspace was created. - # @return [Time] + # @!attribute [rw] status + # The current status of the workspace. + # @return [Types::WorkspaceStatus] # # @!attribute [rw] tags - # The tags of this workspace. + # The list of tag keys and values that are associated with the + # workspace. # @return [Hash] # - # @!attribute [rw] kms_key_arn - # The customer managed KMS key of this workspace. + # @!attribute [rw] workspace_id + # The unique ID for the workspace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceDescription AWS API Documentation # class WorkspaceDescription < Struct.new( - :workspace_id, :alias, :arn, - :status, - :prometheus_endpoint, :created_at, + :kms_key_arn, + :prometheus_endpoint, + :status, :tags, - :kms_key_arn) + :workspace_id) SENSITIVE = [] include Aws::Structure end - # Represents the status of a workspace. + # The status of the workspace. # # @!attribute [rw] status_code - # Status code of this workspace. + # The current status of the workspace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceStatus AWS API Documentation @@ -1721,46 +1870,50 @@ class WorkspaceStatus < Struct.new( include Aws::Structure end - # Represents a summary of the properties of a workspace. - # - # @!attribute [rw] workspace_id - # Unique string identifying this workspace. - # @return [String] + # The information about one Amazon Managed Service for Prometheus + # workspace in your account. # # @!attribute [rw] alias - # Alias of this workspace. + # The alias that is assigned to this workspace to help identify it. It + # may not be unique. # @return [String] # # @!attribute [rw] arn - # The AmazonResourceName of this workspace. + # The ARN of the workspace. # @return [String] # - # @!attribute [rw] status - # The status of this workspace. - # @return [Types::WorkspaceStatus] - # # @!attribute [rw] created_at - # The time when the workspace was created. + # The date and time that the workspace was created. # @return [Time] # + # @!attribute [rw] kms_key_arn + # (optional) If the workspace was created with a customer managed KMS + # key, the ARN for the key used. + # @return [String] + # + # @!attribute [rw] status + # The current status of the workspace. + # @return [Types::WorkspaceStatus] + # # @!attribute [rw] tags - # The tags of this workspace. + # The list of tag keys and values that are associated with the + # workspace. # @return [Hash] # - # @!attribute [rw] kms_key_arn - # Customer managed KMS key ARN for this workspace + # @!attribute [rw] workspace_id + # The unique ID for the workspace. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceSummary AWS API Documentation # class WorkspaceSummary < Struct.new( - :workspace_id, :alias, :arn, - :status, :created_at, + :kms_key_arn, + :status, :tags, - :kms_key_arn) + :workspace_id) SENSITIVE = [] include Aws::Structure end diff --git a/gems/aws-sdk-prometheusservice/sig/client.rbs b/gems/aws-sdk-prometheusservice/sig/client.rbs index fbc37691cff..ddd9f0dcf2d 100644 --- a/gems/aws-sdk-prometheusservice/sig/client.rbs +++ b/gems/aws-sdk-prometheusservice/sig/client.rbs @@ -78,9 +78,9 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#create_alert_manager_definition-instance_method def create_alert_manager_definition: ( - workspace_id: ::String, + ?client_token: ::String, data: ::String, - ?client_token: ::String + workspace_id: ::String ) -> _CreateAlertManagerDefinitionResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAlertManagerDefinitionResponseSuccess @@ -90,39 +90,45 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#create_logging_configuration-instance_method def create_logging_configuration: ( - workspace_id: ::String, + ?client_token: ::String, log_group_arn: ::String, - ?client_token: ::String + workspace_id: ::String ) -> _CreateLoggingConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateLoggingConfigurationResponseSuccess interface _CreateRuleGroupsNamespaceResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateRuleGroupsNamespaceResponse] - def name: () -> ::String def arn: () -> ::String + def name: () -> ::String def status: () -> Types::RuleGroupsNamespaceStatus def tags: () -> ::Hash[::String, ::String] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#create_rule_groups_namespace-instance_method def create_rule_groups_namespace: ( - workspace_id: ::String, - name: ::String, - data: ::String, ?client_token: ::String, - ?tags: Hash[::String, ::String] + data: ::String, + name: ::String, + ?tags: Hash[::String, ::String], + workspace_id: ::String ) -> _CreateRuleGroupsNamespaceResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateRuleGroupsNamespaceResponseSuccess interface _CreateScraperResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateScraperResponse] - def scraper_id: () -> ::String def arn: () -> ::String + def scraper_id: () -> ::String def status: () -> Types::ScraperStatus def tags: () -> ::Hash[::String, ::String] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#create_scraper-instance_method def create_scraper: ( ?alias: ::String, + ?client_token: ::String, + destination: { + amp_configuration: { + workspace_arn: ::String + }? + }, scrape_configuration: { configuration_blob: ::String? }, @@ -133,52 +139,46 @@ module Aws subnet_ids: Array[::String] }? }, - destination: { - amp_configuration: { - workspace_arn: ::String - }? - }, - ?client_token: ::String, ?tags: Hash[::String, ::String] ) -> _CreateScraperResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateScraperResponseSuccess interface _CreateWorkspaceResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::CreateWorkspaceResponse] - def workspace_id: () -> ::String def arn: () -> ::String + def kms_key_arn: () -> ::String def status: () -> Types::WorkspaceStatus def tags: () -> ::Hash[::String, ::String] - def kms_key_arn: () -> ::String + def workspace_id: () -> ::String end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#create_workspace-instance_method def create_workspace: ( ?alias: ::String, ?client_token: ::String, - ?tags: Hash[::String, ::String], - ?kms_key_arn: ::String + ?kms_key_arn: ::String, + ?tags: Hash[::String, ::String] ) -> _CreateWorkspaceResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateWorkspaceResponseSuccess # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#delete_alert_manager_definition-instance_method def delete_alert_manager_definition: ( - workspace_id: ::String, - ?client_token: ::String + ?client_token: ::String, + workspace_id: ::String ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#delete_logging_configuration-instance_method def delete_logging_configuration: ( - workspace_id: ::String, - ?client_token: ::String + ?client_token: ::String, + workspace_id: ::String ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#delete_rule_groups_namespace-instance_method def delete_rule_groups_namespace: ( - workspace_id: ::String, + ?client_token: ::String, name: ::String, - ?client_token: ::String + workspace_id: ::String ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] @@ -189,15 +189,15 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#delete_scraper-instance_method def delete_scraper: ( - scraper_id: ::String, - ?client_token: ::String + ?client_token: ::String, + scraper_id: ::String ) -> _DeleteScraperResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteScraperResponseSuccess # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#delete_workspace-instance_method def delete_workspace: ( - workspace_id: ::String, - ?client_token: ::String + ?client_token: ::String, + workspace_id: ::String ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] @@ -227,8 +227,8 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#describe_rule_groups_namespace-instance_method def describe_rule_groups_namespace: ( - workspace_id: ::String, - name: ::String + name: ::String, + workspace_id: ::String ) -> _DescribeRuleGroupsNamespaceResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeRuleGroupsNamespaceResponseSuccess @@ -263,28 +263,28 @@ module Aws interface _ListRuleGroupsNamespacesResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListRuleGroupsNamespacesResponse] - def rule_groups_namespaces: () -> ::Array[Types::RuleGroupsNamespaceSummary] def next_token: () -> ::String + def rule_groups_namespaces: () -> ::Array[Types::RuleGroupsNamespaceSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#list_rule_groups_namespaces-instance_method def list_rule_groups_namespaces: ( - workspace_id: ::String, + ?max_results: ::Integer, ?name: ::String, ?next_token: ::String, - ?max_results: ::Integer + workspace_id: ::String ) -> _ListRuleGroupsNamespacesResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListRuleGroupsNamespacesResponseSuccess interface _ListScrapersResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListScrapersResponse] - def scrapers: () -> ::Array[Types::ScraperSummary] def next_token: () -> ::String + def scrapers: () -> ::Array[Types::ScraperSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#list_scrapers-instance_method def list_scrapers: ( ?filters: Hash[::String, Array[::String]], - ?next_token: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListScrapersResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListScrapersResponseSuccess @@ -300,14 +300,14 @@ module Aws interface _ListWorkspacesResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::ListWorkspacesResponse] - def workspaces: () -> ::Array[Types::WorkspaceSummary] def next_token: () -> ::String + def workspaces: () -> ::Array[Types::WorkspaceSummary] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#list_workspaces-instance_method def list_workspaces: ( - ?next_token: ::String, ?alias: ::String, - ?max_results: ::Integer + ?max_results: ::Integer, + ?next_token: ::String ) -> _ListWorkspacesResponseSuccess | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListWorkspacesResponseSuccess @@ -317,25 +317,25 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#put_alert_manager_definition-instance_method def put_alert_manager_definition: ( - workspace_id: ::String, + ?client_token: ::String, data: ::String, - ?client_token: ::String + workspace_id: ::String ) -> _PutAlertManagerDefinitionResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutAlertManagerDefinitionResponseSuccess interface _PutRuleGroupsNamespaceResponseSuccess include ::Seahorse::Client::_ResponseSuccess[Types::PutRuleGroupsNamespaceResponse] - def name: () -> ::String def arn: () -> ::String + def name: () -> ::String def status: () -> Types::RuleGroupsNamespaceStatus def tags: () -> ::Hash[::String, ::String] end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#put_rule_groups_namespace-instance_method def put_rule_groups_namespace: ( - workspace_id: ::String, - name: ::String, + ?client_token: ::String, data: ::String, - ?client_token: ::String + name: ::String, + workspace_id: ::String ) -> _PutRuleGroupsNamespaceResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutRuleGroupsNamespaceResponseSuccess @@ -365,17 +365,17 @@ module Aws end # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#update_logging_configuration-instance_method def update_logging_configuration: ( - workspace_id: ::String, + ?client_token: ::String, log_group_arn: ::String, - ?client_token: ::String + workspace_id: ::String ) -> _UpdateLoggingConfigurationResponseSuccess | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateLoggingConfigurationResponseSuccess # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#update_workspace_alias-instance_method def update_workspace_alias: ( - workspace_id: ::String, ?alias: ::String, - ?client_token: ::String + ?client_token: ::String, + workspace_id: ::String ) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> ::Seahorse::Client::_ResponseSuccess[::Aws::EmptyStructure] diff --git a/gems/aws-sdk-prometheusservice/sig/errors.rbs b/gems/aws-sdk-prometheusservice/sig/errors.rbs index 92977f27961..390e03af6f6 100644 --- a/gems/aws-sdk-prometheusservice/sig/errors.rbs +++ b/gems/aws-sdk-prometheusservice/sig/errors.rbs @@ -30,21 +30,21 @@ module Aws end class ServiceQuotaExceededException < ::Aws::Errors::ServiceError def message: () -> ::String + def quota_code: () -> ::String def resource_id: () -> ::String def resource_type: () -> ::String def service_code: () -> ::String - def quota_code: () -> ::String end class ThrottlingException < ::Aws::Errors::ServiceError def message: () -> ::String - def service_code: () -> ::String def quota_code: () -> ::String def retry_after_seconds: () -> ::String + def service_code: () -> ::String end class ValidationException < ::Aws::Errors::ServiceError + def field_list: () -> ::String def message: () -> ::String def reason: () -> ::String - def field_list: () -> ::String end end end diff --git a/gems/aws-sdk-prometheusservice/sig/types.rbs b/gems/aws-sdk-prometheusservice/sig/types.rbs index cbe9529bdde..81c674f621c 100644 --- a/gems/aws-sdk-prometheusservice/sig/types.rbs +++ b/gems/aws-sdk-prometheusservice/sig/types.rbs @@ -14,10 +14,10 @@ module Aws::PrometheusService end class AlertManagerDefinitionDescription - attr_accessor status: Types::AlertManagerDefinitionStatus - attr_accessor data: ::String attr_accessor created_at: ::Time + attr_accessor data: ::String attr_accessor modified_at: ::Time + attr_accessor status: Types::AlertManagerDefinitionStatus SENSITIVE: [] end @@ -40,9 +40,9 @@ module Aws::PrometheusService end class CreateAlertManagerDefinitionRequest - attr_accessor workspace_id: ::String - attr_accessor data: ::String attr_accessor client_token: ::String + attr_accessor data: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -52,9 +52,9 @@ module Aws::PrometheusService end class CreateLoggingConfigurationRequest - attr_accessor workspace_id: ::String - attr_accessor log_group_arn: ::String attr_accessor client_token: ::String + attr_accessor log_group_arn: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -64,17 +64,17 @@ module Aws::PrometheusService end class CreateRuleGroupsNamespaceRequest - attr_accessor workspace_id: ::String - attr_accessor name: ::String - attr_accessor data: ::String attr_accessor client_token: ::String + attr_accessor data: ::String + attr_accessor name: ::String attr_accessor tags: ::Hash[::String, ::String] + attr_accessor workspace_id: ::String SENSITIVE: [] end class CreateRuleGroupsNamespaceResponse - attr_accessor name: ::String attr_accessor arn: ::String + attr_accessor name: ::String attr_accessor status: Types::RuleGroupsNamespaceStatus attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] @@ -82,17 +82,17 @@ module Aws::PrometheusService class CreateScraperRequest attr_accessor alias: ::String + attr_accessor client_token: ::String + attr_accessor destination: Types::Destination attr_accessor scrape_configuration: Types::ScrapeConfiguration attr_accessor source: Types::Source - attr_accessor destination: Types::Destination - attr_accessor client_token: ::String attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end class CreateScraperResponse - attr_accessor scraper_id: ::String attr_accessor arn: ::String + attr_accessor scraper_id: ::String attr_accessor status: Types::ScraperStatus attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] @@ -101,42 +101,42 @@ module Aws::PrometheusService class CreateWorkspaceRequest attr_accessor alias: ::String attr_accessor client_token: ::String - attr_accessor tags: ::Hash[::String, ::String] attr_accessor kms_key_arn: ::String + attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end class CreateWorkspaceResponse - attr_accessor workspace_id: ::String attr_accessor arn: ::String + attr_accessor kms_key_arn: ::String attr_accessor status: Types::WorkspaceStatus attr_accessor tags: ::Hash[::String, ::String] - attr_accessor kms_key_arn: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class DeleteAlertManagerDefinitionRequest - attr_accessor workspace_id: ::String attr_accessor client_token: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class DeleteLoggingConfigurationRequest - attr_accessor workspace_id: ::String attr_accessor client_token: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class DeleteRuleGroupsNamespaceRequest - attr_accessor workspace_id: ::String - attr_accessor name: ::String attr_accessor client_token: ::String + attr_accessor name: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class DeleteScraperRequest - attr_accessor scraper_id: ::String attr_accessor client_token: ::String + attr_accessor scraper_id: ::String SENSITIVE: [] end @@ -147,8 +147,8 @@ module Aws::PrometheusService end class DeleteWorkspaceRequest - attr_accessor workspace_id: ::String attr_accessor client_token: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -173,8 +173,8 @@ module Aws::PrometheusService end class DescribeRuleGroupsNamespaceRequest - attr_accessor workspace_id: ::String attr_accessor name: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -236,29 +236,29 @@ module Aws::PrometheusService end class ListRuleGroupsNamespacesRequest - attr_accessor workspace_id: ::String + attr_accessor max_results: ::Integer attr_accessor name: ::String attr_accessor next_token: ::String - attr_accessor max_results: ::Integer + attr_accessor workspace_id: ::String SENSITIVE: [] end class ListRuleGroupsNamespacesResponse - attr_accessor rule_groups_namespaces: ::Array[Types::RuleGroupsNamespaceSummary] attr_accessor next_token: ::String + attr_accessor rule_groups_namespaces: ::Array[Types::RuleGroupsNamespaceSummary] SENSITIVE: [] end class ListScrapersRequest attr_accessor filters: ::Hash[::String, ::Array[::String]] - attr_accessor next_token: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListScrapersResponse - attr_accessor scrapers: ::Array[Types::ScraperSummary] attr_accessor next_token: ::String + attr_accessor scrapers: ::Array[Types::ScraperSummary] SENSITIVE: [] end @@ -273,24 +273,24 @@ module Aws::PrometheusService end class ListWorkspacesRequest - attr_accessor next_token: ::String attr_accessor alias: ::String attr_accessor max_results: ::Integer + attr_accessor next_token: ::String SENSITIVE: [] end class ListWorkspacesResponse - attr_accessor workspaces: ::Array[Types::WorkspaceSummary] attr_accessor next_token: ::String + attr_accessor workspaces: ::Array[Types::WorkspaceSummary] SENSITIVE: [] end class LoggingConfigurationMetadata - attr_accessor status: Types::LoggingConfigurationStatus - attr_accessor workspace: ::String - attr_accessor log_group_arn: ::String attr_accessor created_at: ::Time + attr_accessor log_group_arn: ::String attr_accessor modified_at: ::Time + attr_accessor status: Types::LoggingConfigurationStatus + attr_accessor workspace: ::String SENSITIVE: [] end @@ -301,9 +301,9 @@ module Aws::PrometheusService end class PutAlertManagerDefinitionRequest - attr_accessor workspace_id: ::String - attr_accessor data: ::String attr_accessor client_token: ::String + attr_accessor data: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -313,16 +313,16 @@ module Aws::PrometheusService end class PutRuleGroupsNamespaceRequest - attr_accessor workspace_id: ::String - attr_accessor name: ::String - attr_accessor data: ::String attr_accessor client_token: ::String + attr_accessor data: ::String + attr_accessor name: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class PutRuleGroupsNamespaceResponse - attr_accessor name: ::String attr_accessor arn: ::String + attr_accessor name: ::String attr_accessor status: Types::RuleGroupsNamespaceStatus attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] @@ -337,11 +337,11 @@ module Aws::PrometheusService class RuleGroupsNamespaceDescription attr_accessor arn: ::String - attr_accessor name: ::String - attr_accessor status: Types::RuleGroupsNamespaceStatus - attr_accessor data: ::String attr_accessor created_at: ::Time + attr_accessor data: ::String attr_accessor modified_at: ::Time + attr_accessor name: ::String + attr_accessor status: Types::RuleGroupsNamespaceStatus attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end @@ -354,10 +354,10 @@ module Aws::PrometheusService class RuleGroupsNamespaceSummary attr_accessor arn: ::String - attr_accessor name: ::String - attr_accessor status: Types::RuleGroupsNamespaceStatus attr_accessor created_at: ::Time attr_accessor modified_at: ::Time + attr_accessor name: ::String + attr_accessor status: Types::RuleGroupsNamespaceStatus attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end @@ -375,17 +375,17 @@ module Aws::PrometheusService class ScraperDescription attr_accessor alias: ::String - attr_accessor scraper_id: ::String attr_accessor arn: ::String - attr_accessor role_arn: ::String - attr_accessor status: Types::ScraperStatus attr_accessor created_at: ::Time + attr_accessor destination: Types::Destination attr_accessor last_modified_at: ::Time - attr_accessor tags: ::Hash[::String, ::String] - attr_accessor status_reason: ::String + attr_accessor role_arn: ::String attr_accessor scrape_configuration: Types::ScrapeConfiguration + attr_accessor scraper_id: ::String attr_accessor source: Types::Source - attr_accessor destination: Types::Destination + attr_accessor status: Types::ScraperStatus + attr_accessor status_reason: ::String + attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end @@ -396,25 +396,25 @@ module Aws::PrometheusService class ScraperSummary attr_accessor alias: ::String - attr_accessor scraper_id: ::String attr_accessor arn: ::String - attr_accessor role_arn: ::String - attr_accessor status: Types::ScraperStatus attr_accessor created_at: ::Time + attr_accessor destination: Types::Destination attr_accessor last_modified_at: ::Time - attr_accessor tags: ::Hash[::String, ::String] - attr_accessor status_reason: ::String + attr_accessor role_arn: ::String + attr_accessor scraper_id: ::String attr_accessor source: Types::Source - attr_accessor destination: Types::Destination + attr_accessor status: Types::ScraperStatus + attr_accessor status_reason: ::String + attr_accessor tags: ::Hash[::String, ::String] SENSITIVE: [] end class ServiceQuotaExceededException attr_accessor message: ::String + attr_accessor quota_code: ::String attr_accessor resource_id: ::String attr_accessor resource_type: ::String attr_accessor service_code: ::String - attr_accessor quota_code: ::String SENSITIVE: [] end @@ -440,9 +440,9 @@ module Aws::PrometheusService class ThrottlingException attr_accessor message: ::String - attr_accessor service_code: ::String attr_accessor quota_code: ::String attr_accessor retry_after_seconds: ::Integer + attr_accessor service_code: ::String SENSITIVE: [] end @@ -456,9 +456,9 @@ module Aws::PrometheusService end class UpdateLoggingConfigurationRequest - attr_accessor workspace_id: ::String - attr_accessor log_group_arn: ::String attr_accessor client_token: ::String + attr_accessor log_group_arn: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -468,34 +468,34 @@ module Aws::PrometheusService end class UpdateWorkspaceAliasRequest - attr_accessor workspace_id: ::String attr_accessor alias: ::String attr_accessor client_token: ::String + attr_accessor workspace_id: ::String SENSITIVE: [] end class ValidationException + attr_accessor field_list: ::Array[Types::ValidationExceptionField] attr_accessor message: ::String attr_accessor reason: ("UNKNOWN_OPERATION" | "CANNOT_PARSE" | "FIELD_VALIDATION_FAILED" | "OTHER") - attr_accessor field_list: ::Array[Types::ValidationExceptionField] SENSITIVE: [] end class ValidationExceptionField - attr_accessor name: ::String attr_accessor message: ::String + attr_accessor name: ::String SENSITIVE: [] end class WorkspaceDescription - attr_accessor workspace_id: ::String attr_accessor alias: ::String attr_accessor arn: ::String - attr_accessor status: Types::WorkspaceStatus - attr_accessor prometheus_endpoint: ::String attr_accessor created_at: ::Time - attr_accessor tags: ::Hash[::String, ::String] attr_accessor kms_key_arn: ::String + attr_accessor prometheus_endpoint: ::String + attr_accessor status: Types::WorkspaceStatus + attr_accessor tags: ::Hash[::String, ::String] + attr_accessor workspace_id: ::String SENSITIVE: [] end @@ -505,13 +505,13 @@ module Aws::PrometheusService end class WorkspaceSummary - attr_accessor workspace_id: ::String attr_accessor alias: ::String attr_accessor arn: ::String - attr_accessor status: Types::WorkspaceStatus attr_accessor created_at: ::Time - attr_accessor tags: ::Hash[::String, ::String] attr_accessor kms_key_arn: ::String + attr_accessor status: Types::WorkspaceStatus + attr_accessor tags: ::Hash[::String, ::String] + attr_accessor workspace_id: ::String SENSITIVE: [] end end