From 6b23b0684be39d8960b5428ad23639b185904e28 Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Fri, 9 Feb 2024 14:21:32 -0500 Subject: [PATCH] Release v1.50.15 (2024-02-09) (#5166) Release v1.50.15 (2024-02-09) === ### Service Client Updates * `service/amp`: Updates service API and documentation * `service/batch`: Updates service API and documentation * This feature allows Batch to support configuration of repository credentials for jobs running on ECS * `service/braket`: Updates service API * `service/cost-optimization-hub`: Updates service API and documentation * `service/ecs`: Updates service documentation * Documentation only update for Amazon ECS. * `service/iot`: Updates service API and documentation * 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. * `service/pricing`: Updates service API and documentation --- CHANGELOG.md | 15 + aws/endpoints/defaults.go | 10 + aws/version.go | 2 +- models/apis/amp/2020-08-01/api-2.json | 428 ++++---- models/apis/amp/2020-08-01/docs-2.json | 570 +++++----- models/apis/batch/2016-08-10/api-2.json | 13 +- models/apis/batch/2016-08-10/docs-2.json | 52 +- .../batch/2016-08-10/endpoint-rule-set-1.json | 424 ++++---- models/apis/braket/2019-09-01/api-2.json | 3 +- .../2022-07-26/api-2.json | 1 + .../2022-07-26/docs-2.json | 5 +- models/apis/ecs/2014-11-13/docs-2.json | 8 +- models/apis/iot/2015-05-28/api-2.json | 16 +- models/apis/iot/2015-05-28/docs-2.json | 18 +- models/apis/pricing/2017-10-15/api-2.json | 20 +- models/apis/pricing/2017-10-15/docs-2.json | 8 +- .../2017-10-15/endpoint-rule-set-1.json | 40 +- models/endpoints/endpoints.json | 6 + service/batch/api.go | 173 ++- service/braket/api.go | 3 + service/costoptimizationhub/api.go | 15 +- service/ecs/api.go | 255 +++-- service/iot/api.go | 75 +- service/pricing/api.go | 79 ++ service/pricing/errors.go | 7 + service/prometheusservice/api.go | 987 +++++++++++------- service/prometheusservice/doc.go | 21 +- service/prometheusservice/errors.go | 15 +- 28 files changed, 1925 insertions(+), 1344 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff02d2cc9e2..8e5a01c7633 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +Release v1.50.15 (2024-02-09) +=== + +### Service Client Updates +* `service/amp`: Updates service API and documentation +* `service/batch`: Updates service API and documentation + * This feature allows Batch to support configuration of repository credentials for jobs running on ECS +* `service/braket`: Updates service API +* `service/cost-optimization-hub`: Updates service API and documentation +* `service/ecs`: Updates service documentation + * Documentation only update for Amazon ECS. +* `service/iot`: Updates service API and documentation + * 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. +* `service/pricing`: Updates service API and documentation + Release v1.50.14 (2024-02-08) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 35d33bb0c6d..44819226422 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -39106,6 +39106,16 @@ var awsusgovPartition = partition{ }: endpoint{}, }, }, + "emr-serverless": service{ + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "us-gov-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-gov-west-1", + }: endpoint{}, + }, + }, "es": service{ Endpoints: serviceEndpoints{ endpointKey{ diff --git a/aws/version.go b/aws/version.go index 7bb37ecc31a..62dc89717b4 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.50.14" +const SDKVersion = "1.50.15" diff --git a/models/apis/amp/2020-08-01/api-2.json b/models/apis/amp/2020-08-01/api-2.json index df11549dd3c..134e9795229 100644 --- a/models/apis/amp/2020-08-01/api-2.json +++ b/models/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/models/apis/amp/2020-08-01/docs-2.json b/models/apis/amp/2020-08-01/docs-2.json index 636b6664439..9f1b5690ec0 100644 --- a/models/apis/amp/2020-08-01/docs-2.json +++ b/models/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/models/apis/batch/2016-08-10/api-2.json b/models/apis/batch/2016-08-10/api-2.json index 5a01de497c2..193b5cc4ccd 100644 --- a/models/apis/batch/2016-08-10/api-2.json +++ b/models/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/models/apis/batch/2016-08-10/docs-2.json b/models/apis/batch/2016-08-10/docs-2.json index b0a717cffda..f5ced0fbc7a 100644 --- a/models/apis/batch/2016-08-10/docs-2.json +++ b/models/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/models/apis/batch/2016-08-10/endpoint-rule-set-1.json b/models/apis/batch/2016-08-10/endpoint-rule-set-1.json index ee7361c8f75..54954abbb7a 100644 --- a/models/apis/batch/2016-08-10/endpoint-rule-set-1.json +++ b/models/apis/batch/2016-08-10/endpoint-rule-set-1.json @@ -40,7 +40,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -58,343 +57,308 @@ "type": "error" }, { - "conditions": [], - "type": "tree", - "rules": [ + "conditions": [ { - "conditions": [ + "fn": "booleanEquals", + "argv": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" + "ref": "UseDualStack" }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" + true + ] } - ] + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] + ], + "type": "tree" }, { - "conditions": [], - "type": "tree", + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], "rules": [ { "conditions": [ { - "fn": "isSet", + "fn": "aws.partition", "argv": [ { "ref": "Region" } - ] + ], + "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ { - "fn": "aws.partition", + "fn": "booleanEquals", "argv": [ { - "ref": "Region" - } - ], - "assign": "PartitionResult" + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseFIPS" - }, - true + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } ] }, { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://batch-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, + } + ], + "rules": [ { "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" + "endpoint": { + "url": "https://batch-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] + ], + "type": "tree" }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] }, true ] } ], - "type": "tree", "rules": [ { "conditions": [ { - "fn": "booleanEquals", + "fn": "stringEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "supportsFIPS" + "name" ] - } + }, + "aws" ] } ], - "type": "tree", - "rules": [ + "endpoint": { + "url": "https://fips.batch.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [ { - "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "stringEquals", - "argv": [ - "aws", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://fips.batch.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - }, + "fn": "stringEquals", + "argv": [ { - "conditions": [ + "fn": "getAttr", + "argv": [ { - "fn": "stringEquals", - "argv": [ - "aws-us-gov", - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "name" - ] - } - ] - } - ], - "endpoint": { - "url": "https://batch.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "ref": "PartitionResult" + }, + "name" + ] }, - { - "conditions": [], - "endpoint": { - "url": "https://batch-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "aws-us-gov" ] } - ] + ], + "endpoint": { + "url": "https://batch.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" }, { "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" + "endpoint": { + "url": "https://batch-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] + ], + "type": "tree" }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ + true, { - "ref": "UseDualStack" - }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", + "fn": "getAttr", "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "type": "tree", - "rules": [ { - "conditions": [], - "endpoint": { - "url": "https://batch.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } + "ref": "PartitionResult" + }, + "supportsDualStack" ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } - ] - }, - { - "conditions": [], - "type": "tree", + ], "rules": [ { "conditions": [], "endpoint": { - "url": "https://batch.{Region}.{PartitionResult#dnsSuffix}", + "url": "https://batch.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } - ] + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } - ] + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://batch.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } - ] - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" + ], + "type": "tree" } - ] + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } \ No newline at end of file diff --git a/models/apis/braket/2019-09-01/api-2.json b/models/apis/braket/2019-09-01/api-2.json index cf1fa7b5473..26f37039d41 100644 --- a/models/apis/braket/2019-09-01/api-2.json +++ b/models/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/models/apis/cost-optimization-hub/2022-07-26/api-2.json b/models/apis/cost-optimization-hub/2022-07-26/api-2.json index b53396cb305..9df87de89fa 100644 --- a/models/apis/cost-optimization-hub/2022-07-26/api-2.json +++ b/models/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/models/apis/cost-optimization-hub/2022-07-26/docs-2.json b/models/apis/cost-optimization-hub/2022-07-26/docs-2.json index f55a95ff265..182d23c4e5b 100644 --- a/models/apis/cost-optimization-hub/2022-07-26/docs-2.json +++ b/models/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/models/apis/ecs/2014-11-13/docs-2.json b/models/apis/ecs/2014-11-13/docs-2.json index ef6dbb5baac..35061cbb538 100644 --- a/models/apis/ecs/2014-11-13/docs-2.json +++ b/models/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/models/apis/iot/2015-05-28/api-2.json b/models/apis/iot/2015-05-28/api-2.json index e19ba06561c..1710a59c680 100644 --- a/models/apis/iot/2015-05-28/api-2.json +++ b/models/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/models/apis/iot/2015-05-28/docs-2.json b/models/apis/iot/2015-05-28/docs-2.json index 90f403ec866..e81c0f69c8c 100644 --- a/models/apis/iot/2015-05-28/docs-2.json +++ b/models/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/models/apis/pricing/2017-10-15/api-2.json b/models/apis/pricing/2017-10-15/api-2.json index 3f1032f32d2..3c9d439e8ab 100644 --- a/models/apis/pricing/2017-10-15/api-2.json +++ b/models/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/models/apis/pricing/2017-10-15/docs-2.json b/models/apis/pricing/2017-10-15/docs-2.json index cc39aa3ba00..19b1e4f94c9 100644 --- a/models/apis/pricing/2017-10-15/docs-2.json +++ b/models/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/models/apis/pricing/2017-10-15/endpoint-rule-set-1.json b/models/apis/pricing/2017-10-15/endpoint-rule-set-1.json index a87f285e6f4..309ef25b584 100644 --- a/models/apis/pricing/2017-10-15/endpoint-rule-set-1.json +++ b/models/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/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index c7687dd4ec6..66628592e43 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.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/service/batch/api.go b/service/batch/api.go index 7f442061172..8ae58b0b353 100644 --- a/service/batch/api.go +++ b/service/batch/api.go @@ -3258,10 +3258,10 @@ type ComputeResource struct { // 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. + // (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. AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"CRAllocationStrategy"` // The maximum percentage that a Spot Instance price can be when compared with @@ -3319,8 +3319,9 @@ type ComputeResource struct { ImageId *string `locationName:"imageId" deprecated:"true" type:"string"` // 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:::instance-profile/ecsInstanceRole + // 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 // . For more information, see Amazon ECS instance role (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) // in the Batch User Guide. // @@ -3359,12 +3360,11 @@ type ComputeResource struct { // 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 + // 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. + // more than a single instance. // // MaxvCpus is a required field MaxvCpus *int64 `locationName:"maxvCpus" type:"integer" required:"true"` @@ -3651,11 +3651,11 @@ type ComputeResourceUpdate struct { // 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. + // 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. AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"CRUpdateAllocationStrategy"` // The maximum percentage that a Spot Instance price can be when compared with @@ -3745,8 +3745,9 @@ type ComputeResourceUpdate struct { ImageId *string `locationName:"imageId" type:"string"` // 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:::instance-profile/ecsInstanceRole + // 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 (https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html) // in the Batch User Guide. // @@ -3803,12 +3804,11 @@ type ComputeResourceUpdate struct { // 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 + // 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. + // more than a single instance. MaxvCpus *int64 `locationName:"maxvCpus" type:"integer"` // The minimum number of vCPUs that an environment should maintain (even if @@ -4182,6 +4182,9 @@ type ContainerDetail struct { // details for a running or stopped container. Reason *string `locationName:"reason" type:"string"` + // The private repository authentication credentials to use. + RepositoryCredentials *RepositoryCredentials `locationName:"repositoryCredentials" type:"structure"` + // The type and amount of resources to assign to a container. The supported // resources include GPU, MEMORY, and VCPU. ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"` @@ -4371,6 +4374,12 @@ func (s *ContainerDetail) SetReason(v string) *ContainerDetail { return s } +// SetRepositoryCredentials sets the RepositoryCredentials field's value. +func (s *ContainerDetail) SetRepositoryCredentials(v *RepositoryCredentials) *ContainerDetail { + s.RepositoryCredentials = v + return s +} + // SetResourceRequirements sets the ResourceRequirements field's value. func (s *ContainerDetail) SetResourceRequirements(v []*ResourceRequirement) *ContainerDetail { s.ResourceRequirements = v @@ -4596,12 +4605,12 @@ type ContainerProperties struct { // Jobs that are running on EC2 resources must not specify this parameter. FargatePlatformConfiguration *FargatePlatformConfiguration `locationName:"fargatePlatformConfiguration" type:"structure"` - // 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 + // 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 // (https://docs.docker.com/engine/api/v1.23/#create-a-container) section of // the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) and the // IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). @@ -4713,6 +4722,9 @@ type ContainerProperties struct { // --read-only option to docker run. ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` + // The private repository authentication credentials to use. + RepositoryCredentials *RepositoryCredentials `locationName:"repositoryCredentials" type:"structure"` + // The type and amount of resources to assign to a container. The supported // resources include GPU, MEMORY, and VCPU. ResourceRequirements []*ResourceRequirement `locationName:"resourceRequirements" type:"list"` @@ -4796,6 +4808,11 @@ func (s *ContainerProperties) Validate() error { invalidParams.AddNested("LogConfiguration", err.(request.ErrInvalidParams)) } } + if s.RepositoryCredentials != nil { + if err := s.RepositoryCredentials.Validate(); err != nil { + invalidParams.AddNested("RepositoryCredentials", err.(request.ErrInvalidParams)) + } + } if s.ResourceRequirements != nil { for i, v := range s.ResourceRequirements { if v == nil { @@ -4933,6 +4950,12 @@ func (s *ContainerProperties) SetReadonlyRootFilesystem(v bool) *ContainerProper return s } +// SetRepositoryCredentials sets the RepositoryCredentials field's value. +func (s *ContainerProperties) SetRepositoryCredentials(v *RepositoryCredentials) *ContainerProperties { + s.RepositoryCredentials = v + return s +} + // SetResourceRequirements sets the ResourceRequirements field's value. func (s *ContainerProperties) SetResourceRequirements(v []*ResourceRequirement) *ContainerProperties { s.ResourceRequirements = v @@ -5954,7 +5977,8 @@ type DescribeJobDefinitionsInput struct { // 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}. + // or a short version using the form ${JobDefinitionName}:${Revision}. This + // parameter can't be used with other parameters. JobDefinitions []*string `locationName:"jobDefinitions" type:"list"` // The maximum number of results returned by DescribeJobDefinitions in paginated @@ -6606,6 +6630,13 @@ type Ec2Configuration struct { // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html): + // Batch supports Amazon Linux 2023. + // + // Amazon Linux 2023 does not support A1 instances. + // // ECS_AL1 // // Amazon Linux (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami). @@ -8510,7 +8541,7 @@ type FairsharePolicy struct { // 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 + // 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 @@ -9018,8 +9049,6 @@ type JobDetail struct { // 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. // // StartedAt is a required field StartedAt *int64 `locationName:"startedAt" type:"long" required:"true"` @@ -10390,7 +10419,7 @@ func (s *LogConfiguration) SetSecretOptions(v []*Secret) *LogConfiguration { } // 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 (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container) +// properties. This parameter maps to Volumes in the Create a container (https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerCreate) // section of the Docker Remote API and the --volume option to docker run. type MountPoint struct { _ struct{} `type:"structure"` @@ -11210,6 +11239,54 @@ func (s *RegisterJobDefinitionOutput) SetRevision(v int64) *RegisterJobDefinitio return s } +// The repository credentials for private registry authentication. +type RepositoryCredentials struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the secret containing the private repository + // credentials. + // + // CredentialsParameter is a required field + CredentialsParameter *string `locationName:"credentialsParameter" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RepositoryCredentials) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RepositoryCredentials) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RepositoryCredentials) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RepositoryCredentials"} + if s.CredentialsParameter == nil { + invalidParams.Add(request.NewErrParamRequired("CredentialsParameter")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCredentialsParameter sets the CredentialsParameter field's value. +func (s *RepositoryCredentials) SetCredentialsParameter(v string) *RepositoryCredentials { + s.CredentialsParameter = &v + return s +} + // The type and amount of a resource to assign to a container. The supported // resources include GPU, MEMORY, and VCPU. type ResourceRequirement struct { @@ -11493,6 +11570,12 @@ type RuntimePlatform struct { // 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. CpuArchitecture *string `locationName:"cpuArchitecture" type:"string"` // The operating system for the compute environment. Valid values are: LINUX @@ -11502,15 +11585,18 @@ type RuntimePlatform struct { // 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 + // 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 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. OperatingSystemFamily *string `locationName:"operatingSystemFamily" type:"string"` } @@ -11948,7 +12034,7 @@ type SubmitJobInput struct { // 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. + // 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. SchedulingPriorityOverride *int64 `locationName:"schedulingPriorityOverride" type:"integer"` @@ -12440,7 +12526,8 @@ func (s *Tmpfs) SetSize(v int64) *Tmpfs { return s } -// The ulimit settings to pass to the container. +// The ulimit settings to pass to the container. For more information, see Ulimit +// (https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html). // // This object isn't applicable to jobs that are running on Fargate resources. type Ulimit struct { @@ -12451,7 +12538,9 @@ type Ulimit struct { // HardLimit is a required field HardLimit *int64 `locationName:"hardLimit" type:"integer" required:"true"` - // 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. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` diff --git a/service/braket/api.go b/service/braket/api.go index f5bddd5365c..50d2d2fae91 100644 --- a/service/braket/api.go +++ b/service/braket/api.go @@ -266,6 +266,9 @@ func (c *Braket) CreateJobRequest(input *CreateJobInput) (req *request.Request, // - ThrottlingException // The throttling rate limit is met. // +// - DeviceOfflineException +// The specified device is currently offline. +// // - DeviceRetiredException // The specified device has been retired. // diff --git a/service/costoptimizationhub/api.go b/service/costoptimizationhub/api.go index 245155acde4..6b843ed65ce 100644 --- a/service/costoptimizationhub/api.go +++ b/service/costoptimizationhub/api.go @@ -2718,7 +2718,7 @@ func (s *LambdaFunctionConfiguration) SetCompute(v *ComputeConfiguration) *Lambd type ListEnrollmentStatusesInput struct { _ struct{} `type:"structure"` - // The enrollment status of a specific account ID in the organization. + // The account ID of a member account in the organization. AccountId *string `locationName:"accountId" type:"string"` // Indicates whether to return the enrollment status for the organization. @@ -2776,7 +2776,12 @@ func (s *ListEnrollmentStatusesInput) SetNextToken(v string) *ListEnrollmentStat type ListEnrollmentStatusesOutput struct { _ struct{} `type:"structure"` - // The account enrollment statuses. + // The enrollment status of all member accounts in the organization if the account + // is the management account. + IncludeMemberAccounts *bool `locationName:"includeMemberAccounts" type:"boolean"` + + // The enrollment status of a specific account ID, including creation and last + // updated timestamps. Items []*AccountEnrollmentStatus `locationName:"items" type:"list"` // The token to retrieve the next set of results. @@ -2801,6 +2806,12 @@ func (s ListEnrollmentStatusesOutput) GoString() string { return s.String() } +// SetIncludeMemberAccounts sets the IncludeMemberAccounts field's value. +func (s *ListEnrollmentStatusesOutput) SetIncludeMemberAccounts(v bool) *ListEnrollmentStatusesOutput { + s.IncludeMemberAccounts = &v + return s +} + // SetItems sets the Items field's value. func (s *ListEnrollmentStatusesOutput) SetItems(v []*AccountEnrollmentStatus) *ListEnrollmentStatusesOutput { s.Items = v diff --git a/service/ecs/api.go b/service/ecs/api.go index 0dda49d35a8..5a55dc125db 100644 --- a/service/ecs/api.go +++ b/service/ecs/api.go @@ -3995,52 +3995,6 @@ func (c *ECS) PutAccountSettingRequest(input *PutAccountSettingInput) (req *requ // For more information, see Account Settings (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html) // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html) -// 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 -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) -// 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 -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html) -// 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 -// (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) -// 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html). -// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -18823,40 +18777,83 @@ func (s *ProxyConfiguration) SetType(v string) *ProxyConfiguration { type PutAccountSettingDefaultInput struct { _ struct{} `type:"structure"` - // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources) - // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-fips-compliance.html) - // in the Amazon Elastic Container Service Developer Guide. + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html) + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) - // in the Amazon ECS 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) + // in the Amazon Elastic Container Service 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 (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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack). + // For more information on using IPv6 with tasks launched on Fargate, see + // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack). + // + // * 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) + // 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 + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html) + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html). // // Name is a required field Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"` @@ -18960,26 +18957,83 @@ func (s *PutAccountSettingDefaultOutput) SetSetting(v *Setting) *PutAccountSetti type PutAccountSettingInput struct { _ struct{} `type:"structure"` - // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#tag-resources) - // 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 (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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-eni.html) + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cloudwatch-container-insights.html) + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking-awsvpc.html#task-networking-vpc-dual-stack). + // For more information on using IPv6 with tasks launched on Fargate, see + // Using a VPC in dual-stack mode (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-task-networking.html#fargate-task-networking-vpc-dual-stack). + // + // * 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-maintenance.html) + // 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 + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/supported-iam-actions-tagging.html) + // 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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-guard-duty-integration.html). // // Name is a required field Name *string `locationName:"name" type:"string" required:"true" enum:"SettingName"` @@ -20767,6 +20821,11 @@ type RunTaskOutput struct { _ struct{} `type:"structure"` // Any failures associated with the call. + // + // For information about how to address failures, see Service event messages + // (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages.html#service-event-messages-list) + // and API failure reasons (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) + // in the Amazon Elastic Container Service Developer Guide. Failures []*Failure `locationName:"failures" type:"list"` // A full description of the tasks that were run. The tasks that were successfully diff --git a/service/iot/api.go b/service/iot/api.go index 9c3c5fabed5..d91ce2edfcc 100644 --- a/service/iot/api.go +++ b/service/iot/api.go @@ -9189,8 +9189,11 @@ func (c *IoT) DescribeEndpointRequest(input *DescribeEndpointInput) (req *reques // DescribeEndpoint API operation for AWS IoT. // -// 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 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. @@ -12811,6 +12814,10 @@ func (c *IoT) GetRegistrationCodeRequest(input *GetRegistrationCodeInput) (req * // // 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 (https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) // action. // @@ -33710,6 +33717,9 @@ type CreateDomainConfigurationInput struct { // is not required for Amazon Web Services-managed domains. ServerCertificateArns []*string `locationName:"serverCertificateArns" type:"list"` + // The server certificate configuration. + ServerCertificateConfig *ServerCertificateConfig `locationName:"serverCertificateConfig" type:"structure"` + // The type of service delivered by the endpoint. // // Amazon Web Services IoT Core currently supports only the DATA service type. @@ -33812,6 +33822,12 @@ func (s *CreateDomainConfigurationInput) SetServerCertificateArns(v []*string) * return s } +// SetServerCertificateConfig sets the ServerCertificateConfig field's value. +func (s *CreateDomainConfigurationInput) SetServerCertificateConfig(v *ServerCertificateConfig) *CreateDomainConfigurationInput { + s.ServerCertificateConfig = v + return s +} + // SetServiceType sets the ServiceType field's value. func (s *CreateDomainConfigurationInput) SetServiceType(v string) *CreateDomainConfigurationInput { s.ServiceType = &v @@ -42259,6 +42275,9 @@ type DescribeDomainConfigurationOutput struct { // The date and time the domain configuration's status was last changed. LastStatusChangeDate *time.Time `locationName:"lastStatusChangeDate" type:"timestamp"` + // The server certificate configuration. + ServerCertificateConfig *ServerCertificateConfig `locationName:"serverCertificateConfig" type:"structure"` + // A list containing summary information about the server certificate included // in the domain configuration. ServerCertificates []*ServerCertificateSummary `locationName:"serverCertificates" type:"list"` @@ -42330,6 +42349,12 @@ func (s *DescribeDomainConfigurationOutput) SetLastStatusChangeDate(v time.Time) return s } +// SetServerCertificateConfig sets the ServerCertificateConfig field's value. +func (s *DescribeDomainConfigurationOutput) SetServerCertificateConfig(v *ServerCertificateConfig) *DescribeDomainConfigurationOutput { + s.ServerCertificateConfig = v + return s +} + // SetServerCertificates sets the ServerCertificates field's value. func (s *DescribeDomainConfigurationOutput) SetServerCertificates(v []*ServerCertificateSummary) *DescribeDomainConfigurationOutput { s.ServerCertificates = v @@ -63888,6 +63913,43 @@ func (s *SecurityProfileTargetMapping) SetTarget(v *SecurityProfileTarget) *Secu return s } +// The server certificate configuration. +type ServerCertificateConfig struct { + _ struct{} `type:"structure"` + + // 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 (https://docs.aws.amazon.com/iot/latest/developerguide/iot-custom-domain-ocsp-config.html) + // from Amazon Web Services IoT Core Developer Guide. + EnableOCSPCheck *bool `locationName:"enableOCSPCheck" type:"boolean"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerCertificateConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerCertificateConfig) GoString() string { + return s.String() +} + +// SetEnableOCSPCheck sets the EnableOCSPCheck field's value. +func (s *ServerCertificateConfig) SetEnableOCSPCheck(v bool) *ServerCertificateConfig { + s.EnableOCSPCheck = &v + return s +} + // An object that contains information about a server certificate. type ServerCertificateSummary struct { _ struct{} `type:"structure"` @@ -70094,6 +70156,9 @@ type UpdateDomainConfigurationInput struct { // Removes the authorization configuration from a domain. RemoveAuthorizerConfig *bool `locationName:"removeAuthorizerConfig" type:"boolean"` + // The server certificate configuration. + ServerCertificateConfig *ServerCertificateConfig `locationName:"serverCertificateConfig" type:"structure"` + // An object that specifies the TLS configuration for a domain. TlsConfig *TlsConfig `locationName:"tlsConfig" type:"structure"` } @@ -70161,6 +70226,12 @@ func (s *UpdateDomainConfigurationInput) SetRemoveAuthorizerConfig(v bool) *Upda return s } +// SetServerCertificateConfig sets the ServerCertificateConfig field's value. +func (s *UpdateDomainConfigurationInput) SetServerCertificateConfig(v *ServerCertificateConfig) *UpdateDomainConfigurationInput { + s.ServerCertificateConfig = v + return s +} + // SetTlsConfig sets the TlsConfig field's value. func (s *UpdateDomainConfigurationInput) SetTlsConfig(v *TlsConfig) *UpdateDomainConfigurationInput { s.TlsConfig = v diff --git a/service/pricing/api.go b/service/pricing/api.go index ba3b5c30931..32665ac28b8 100644 --- a/service/pricing/api.go +++ b/service/pricing/api.go @@ -90,6 +90,9 @@ func (c *Pricing) DescribeServicesRequest(input *DescribeServicesInput) (req *re // An error on the server occurred during the processing of your request. Try // again later. // +// - ThrottlingException +// You've made too many requests exceeding service quotas. +// // - ExpiredNextTokenException // The pagination token expired. Try again without a pagination token. // @@ -242,6 +245,9 @@ func (c *Pricing) GetAttributeValuesRequest(input *GetAttributeValuesInput) (req // An error on the server occurred during the processing of your request. Try // again later. // +// - ThrottlingException +// You've made too many requests exceeding service quotas. +// // - ExpiredNextTokenException // The pagination token expired. Try again without a pagination token. // @@ -393,6 +399,9 @@ func (c *Pricing) GetPriceListFileUrlRequest(input *GetPriceListFileUrlInput) (r // An error on the server occurred during the processing of your request. Try // again later. // +// - ThrottlingException +// You've made too many requests exceeding service quotas. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/pricing-2017-10-15/GetPriceListFileUrl func (c *Pricing) GetPriceListFileUrl(input *GetPriceListFileUrlInput) (*GetPriceListFileUrlOutput, error) { req, out := c.GetPriceListFileUrlRequest(input) @@ -488,6 +497,9 @@ func (c *Pricing) GetProductsRequest(input *GetProductsInput) (req *request.Requ // An error on the server occurred during the processing of your request. Try // again later. // +// - ThrottlingException +// You've made too many requests exceeding service quotas. +// // - ExpiredNextTokenException // The pagination token expired. Try again without a pagination token. // @@ -652,6 +664,9 @@ func (c *Pricing) ListPriceListsRequest(input *ListPriceListsInput) (req *reques // An error on the server occurred during the processing of your request. Try // again later. // +// - ThrottlingException +// You've made too many requests exceeding service quotas. +// // - ExpiredNextTokenException // The pagination token expired. Try again without a pagination token. // @@ -2020,6 +2035,70 @@ func (s *Service) SetServiceCode(v string) *Service { return s } +// You've made too many requests exceeding service quotas. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + const ( // FilterTypeTermMatch is a FilterType enum value FilterTypeTermMatch = "TERM_MATCH" diff --git a/service/pricing/errors.go b/service/pricing/errors.go index a5cddd61eed..6c05802a344 100644 --- a/service/pricing/errors.go +++ b/service/pricing/errors.go @@ -44,6 +44,12 @@ const ( // // The requested resource can't be found. ErrCodeNotFoundException = "NotFoundException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // You've made too many requests exceeding service quotas. + ErrCodeThrottlingException = "ThrottlingException" ) var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ @@ -53,4 +59,5 @@ var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "InvalidNextTokenException": newErrorInvalidNextTokenException, "InvalidParameterException": newErrorInvalidParameterException, "NotFoundException": newErrorNotFoundException, + "ThrottlingException": newErrorThrottlingException, } diff --git a/service/prometheusservice/api.go b/service/prometheusservice/api.go index 5632ae363d9..8f29f2155d3 100644 --- a/service/prometheusservice/api.go +++ b/service/prometheusservice/api.go @@ -56,7 +56,9 @@ func (c *PrometheusService) CreateAlertManagerDefinitionRequest(input *CreateAle // CreateAlertManagerDefinition API operation for Amazon Prometheus Service. // -// Create an alert manager definition. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -68,25 +70,26 @@ func (c *PrometheusService) CreateAlertManagerDefinitionRequest(input *CreateAle // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateAlertManagerDefinition func (c *PrometheusService) CreateAlertManagerDefinition(input *CreateAlertManagerDefinitionInput) (*CreateAlertManagerDefinitionOutput, error) { @@ -153,7 +156,9 @@ func (c *PrometheusService) CreateLoggingConfigurationRequest(input *CreateLoggi // CreateLoggingConfiguration API operation for Amazon Prometheus Service. // -// Create logging configuration. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -165,16 +170,17 @@ func (c *PrometheusService) CreateLoggingConfigurationRequest(input *CreateLoggi // Returned Error Types: // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateLoggingConfiguration func (c *PrometheusService) CreateLoggingConfiguration(input *CreateLoggingConfigurationInput) (*CreateLoggingConfigurationOutput, error) { @@ -241,7 +247,12 @@ func (c *PrometheusService) CreateRuleGroupsNamespaceRequest(input *CreateRuleGr // CreateRuleGroupsNamespace API operation for Amazon Prometheus Service. // -// Create a 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. +// +// Use this operation only to create new rule groups namespaces. To update an +// existing rule groups namespace, use PutRuleGroupsNamespace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -253,25 +264,26 @@ func (c *PrometheusService) CreateRuleGroupsNamespaceRequest(input *CreateRuleGr // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateRuleGroupsNamespace func (c *PrometheusService) CreateRuleGroupsNamespace(input *CreateRuleGroupsNamespaceInput) (*CreateRuleGroupsNamespaceOutput, error) { @@ -338,7 +350,27 @@ func (c *PrometheusService) CreateScraperRequest(input *CreateScraperInput) (req // CreateScraper API operation for Amazon Prometheus Service. // -// 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. +// +// 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 (https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper) +// 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 +// (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html) +// in the Amazon Managed Service for Prometheus User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -350,25 +382,26 @@ func (c *PrometheusService) CreateScraperRequest(input *CreateScraperInput) (req // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateScraper func (c *PrometheusService) CreateScraper(input *CreateScraperInput) (*CreateScraperOutput, error) { @@ -435,7 +468,9 @@ func (c *PrometheusService) CreateWorkspaceRequest(input *CreateWorkspaceInput) // CreateWorkspace API operation for Amazon Prometheus Service. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -447,22 +482,23 @@ func (c *PrometheusService) CreateWorkspaceRequest(input *CreateWorkspaceInput) // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace func (c *PrometheusService) CreateWorkspace(input *CreateWorkspaceInput) (*CreateWorkspaceOutput, error) { @@ -530,7 +566,7 @@ func (c *PrometheusService) DeleteAlertManagerDefinitionRequest(input *DeleteAle // DeleteAlertManagerDefinition API operation for Amazon Prometheus Service. // -// Deletes an alert manager definition. +// Deletes the alert manager definition from a workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -542,22 +578,23 @@ func (c *PrometheusService) DeleteAlertManagerDefinitionRequest(input *DeleteAle // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinition func (c *PrometheusService) DeleteAlertManagerDefinition(input *DeleteAlertManagerDefinitionInput) (*DeleteAlertManagerDefinitionOutput, error) { @@ -625,7 +662,7 @@ func (c *PrometheusService) DeleteLoggingConfigurationRequest(input *DeleteLoggi // DeleteLoggingConfiguration API operation for Amazon Prometheus Service. // -// Delete logging configuration. +// Deletes the logging configuration for a workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -637,19 +674,20 @@ func (c *PrometheusService) DeleteLoggingConfigurationRequest(input *DeleteLoggi // Returned Error Types: // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfiguration func (c *PrometheusService) DeleteLoggingConfiguration(input *DeleteLoggingConfigurationInput) (*DeleteLoggingConfigurationOutput, error) { @@ -717,7 +755,7 @@ func (c *PrometheusService) DeleteRuleGroupsNamespaceRequest(input *DeleteRuleGr // DeleteRuleGroupsNamespace API operation for Amazon Prometheus Service. // -// Delete a rule groups namespace. +// Deletes one rule groups namespace and its associated rule groups definition. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -729,22 +767,23 @@ func (c *PrometheusService) DeleteRuleGroupsNamespaceRequest(input *DeleteRuleGr // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespace func (c *PrometheusService) DeleteRuleGroupsNamespace(input *DeleteRuleGroupsNamespaceInput) (*DeleteRuleGroupsNamespaceOutput, error) { @@ -811,7 +850,8 @@ func (c *PrometheusService) DeleteScraperRequest(input *DeleteScraperInput) (req // DeleteScraper API operation for Amazon Prometheus Service. // -// Deletes a scraper. +// The DeleteScraper operation deletes one scraper, and stops any metrics collection +// that the scraper performs. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -823,22 +863,23 @@ func (c *PrometheusService) DeleteScraperRequest(input *DeleteScraperInput) (req // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraper func (c *PrometheusService) DeleteScraper(input *DeleteScraperInput) (*DeleteScraperOutput, error) { @@ -906,7 +947,10 @@ func (c *PrometheusService) DeleteWorkspaceRequest(input *DeleteWorkspaceInput) // DeleteWorkspace API operation for Amazon Prometheus Service. // -// Deletes an AMP workspace. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -918,22 +962,23 @@ func (c *PrometheusService) DeleteWorkspaceRequest(input *DeleteWorkspaceInput) // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace func (c *PrometheusService) DeleteWorkspace(input *DeleteWorkspaceInput) (*DeleteWorkspaceOutput, error) { @@ -1000,7 +1045,7 @@ func (c *PrometheusService) DescribeAlertManagerDefinitionRequest(input *Describ // DescribeAlertManagerDefinition API operation for Amazon Prometheus Service. // -// Describes an alert manager definition. +// Retrieves the full information about the alert manager definition for a workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1012,19 +1057,20 @@ func (c *PrometheusService) DescribeAlertManagerDefinitionRequest(input *Describ // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinition func (c *PrometheusService) DescribeAlertManagerDefinition(input *DescribeAlertManagerDefinitionInput) (*DescribeAlertManagerDefinitionOutput, error) { @@ -1091,7 +1137,8 @@ func (c *PrometheusService) DescribeLoggingConfigurationRequest(input *DescribeL // DescribeLoggingConfiguration API operation for Amazon Prometheus Service. // -// Describes logging configuration. +// Returns complete information about the current logging configuration of the +// workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1103,16 +1150,17 @@ func (c *PrometheusService) DescribeLoggingConfigurationRequest(input *DescribeL // Returned Error Types: // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfiguration func (c *PrometheusService) DescribeLoggingConfiguration(input *DescribeLoggingConfigurationInput) (*DescribeLoggingConfigurationOutput, error) { @@ -1179,7 +1227,8 @@ func (c *PrometheusService) DescribeRuleGroupsNamespaceRequest(input *DescribeRu // DescribeRuleGroupsNamespace API operation for Amazon Prometheus Service. // -// Describe a rule groups namespace. +// Returns complete information about one rule groups namespace. To retrieve +// a list of rule groups namespaces, use ListRuleGroupsNamespaces. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1191,19 +1240,20 @@ func (c *PrometheusService) DescribeRuleGroupsNamespaceRequest(input *DescribeRu // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeRuleGroupsNamespace func (c *PrometheusService) DescribeRuleGroupsNamespace(input *DescribeRuleGroupsNamespaceInput) (*DescribeRuleGroupsNamespaceOutput, error) { @@ -1270,7 +1320,7 @@ func (c *PrometheusService) DescribeScraperRequest(input *DescribeScraperInput) // DescribeScraper API operation for Amazon Prometheus Service. // -// Describe an existing scraper. +// The DescribeScraper operation displays information about an existing scraper. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1282,19 +1332,20 @@ func (c *PrometheusService) DescribeScraperRequest(input *DescribeScraperInput) // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeScraper func (c *PrometheusService) DescribeScraper(input *DescribeScraperInput) (*DescribeScraperOutput, error) { @@ -1361,7 +1412,7 @@ func (c *PrometheusService) DescribeWorkspaceRequest(input *DescribeWorkspaceInp // DescribeWorkspace API operation for Amazon Prometheus Service. // -// Describes an existing AMP workspace. +// Returns information about an existing workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1373,19 +1424,20 @@ func (c *PrometheusService) DescribeWorkspaceRequest(input *DescribeWorkspaceInp // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeWorkspace func (c *PrometheusService) DescribeWorkspace(input *DescribeWorkspaceInput) (*DescribeWorkspaceOutput, error) { @@ -1452,7 +1504,8 @@ func (c *PrometheusService) GetDefaultScraperConfigurationRequest(input *GetDefa // GetDefaultScraperConfiguration API operation for Amazon Prometheus Service. // -// Gets a default configuration. +// The GetDefaultScraperConfiguration operation returns the default scraper +// configuration used when Amazon EKS creates a scraper for you. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1464,13 +1517,13 @@ func (c *PrometheusService) GetDefaultScraperConfigurationRequest(input *GetDefa // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/GetDefaultScraperConfiguration func (c *PrometheusService) GetDefaultScraperConfiguration(input *GetDefaultScraperConfigurationInput) (*GetDefaultScraperConfigurationOutput, error) { @@ -1543,7 +1596,7 @@ func (c *PrometheusService) ListRuleGroupsNamespacesRequest(input *ListRuleGroup // ListRuleGroupsNamespaces API operation for Amazon Prometheus Service. // -// Lists rule groups namespaces. +// Returns a list of rule groups namespaces in a workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1555,19 +1608,20 @@ func (c *PrometheusService) ListRuleGroupsNamespacesRequest(input *ListRuleGroup // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespaces func (c *PrometheusService) ListRuleGroupsNamespaces(input *ListRuleGroupsNamespacesInput) (*ListRuleGroupsNamespacesOutput, error) { @@ -1691,8 +1745,9 @@ func (c *PrometheusService) ListScrapersRequest(input *ListScrapersInput) (req * // ListScrapers API operation for Amazon Prometheus Service. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1704,16 +1759,17 @@ func (c *PrometheusService) ListScrapersRequest(input *ListScrapersInput) (req * // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapers func (c *PrometheusService) ListScrapers(input *ListScrapersInput) (*ListScrapersOutput, error) { @@ -1831,7 +1887,9 @@ func (c *PrometheusService) ListTagsForResourceRequest(input *ListTagsForResourc // ListTagsForResource API operation for Amazon Prometheus Service. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1843,19 +1901,20 @@ func (c *PrometheusService) ListTagsForResourceRequest(input *ListTagsForResourc // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResource func (c *PrometheusService) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { @@ -1928,7 +1987,8 @@ func (c *PrometheusService) ListWorkspacesRequest(input *ListWorkspacesInput) (r // ListWorkspaces API operation for Amazon Prometheus Service. // -// Lists all AMP workspaces, including workspaces being created or deleted. +// Lists all of the Amazon Managed Service for Prometheus workspaces in your +// account. This includes workspaces being created or deleted. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1940,16 +2000,17 @@ func (c *PrometheusService) ListWorkspacesRequest(input *ListWorkspacesInput) (r // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces func (c *PrometheusService) ListWorkspaces(input *ListWorkspacesInput) (*ListWorkspacesOutput, error) { @@ -2067,7 +2128,9 @@ func (c *PrometheusService) PutAlertManagerDefinitionRequest(input *PutAlertMana // PutAlertManagerDefinition API operation for Amazon Prometheus Service. // -// Update an alert manager definition. +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2079,25 +2142,26 @@ func (c *PrometheusService) PutAlertManagerDefinitionRequest(input *PutAlertMana // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutAlertManagerDefinition func (c *PrometheusService) PutAlertManagerDefinition(input *PutAlertManagerDefinitionInput) (*PutAlertManagerDefinitionOutput, error) { @@ -2164,7 +2228,15 @@ func (c *PrometheusService) PutRuleGroupsNamespaceRequest(input *PutRuleGroupsNa // PutRuleGroupsNamespace API operation for Amazon Prometheus Service. // -// 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. +// +// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2176,25 +2248,26 @@ func (c *PrometheusService) PutRuleGroupsNamespaceRequest(input *PutRuleGroupsNa // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/PutRuleGroupsNamespace func (c *PrometheusService) PutRuleGroupsNamespace(input *PutRuleGroupsNamespaceInput) (*PutRuleGroupsNamespaceOutput, error) { @@ -2262,7 +2335,14 @@ func (c *PrometheusService) TagResourceRequest(input *TagResourceInput) (req *re // TagResource API operation for Amazon Prometheus Service. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2274,19 +2354,20 @@ func (c *PrometheusService) TagResourceRequest(input *TagResourceInput) (req *re // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/TagResource func (c *PrometheusService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { @@ -2354,7 +2435,9 @@ func (c *PrometheusService) UntagResourceRequest(input *UntagResourceInput) (req // UntagResource API operation for Amazon Prometheus Service. // -// 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. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2366,19 +2449,20 @@ func (c *PrometheusService) UntagResourceRequest(input *UntagResourceInput) (req // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UntagResource func (c *PrometheusService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { @@ -2445,7 +2529,7 @@ func (c *PrometheusService) UpdateLoggingConfigurationRequest(input *UpdateLoggi // UpdateLoggingConfiguration API operation for Amazon Prometheus Service. // -// Update logging configuration. +// Updates the log group ARN or the workspace ID of the current logging configuration. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2457,19 +2541,20 @@ func (c *PrometheusService) UpdateLoggingConfigurationRequest(input *UpdateLoggi // Returned Error Types: // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateLoggingConfiguration func (c *PrometheusService) UpdateLoggingConfiguration(input *UpdateLoggingConfigurationInput) (*UpdateLoggingConfigurationOutput, error) { @@ -2537,7 +2622,7 @@ func (c *PrometheusService) UpdateWorkspaceAliasRequest(input *UpdateWorkspaceAl // UpdateWorkspaceAlias API operation for Amazon Prometheus Service. // -// Updates an AMP workspace alias. +// Updates the alias of an existing workspace. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2549,25 +2634,26 @@ func (c *PrometheusService) UpdateWorkspaceAliasRequest(input *UpdateWorkspaceAl // Returned Error Types: // // - ThrottlingException -// Request was denied due to request throttling. +// The request was denied due to request throttling. // // - ConflictException -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. // // - ValidationException -// 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. // // - ResourceNotFoundException -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. // // - AccessDeniedException -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. // // - InternalServerException -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. // // - ServiceQuotaExceededException -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. // // See also, https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias func (c *PrometheusService) UpdateWorkspaceAlias(input *UpdateWorkspaceAliasInput) (*UpdateWorkspaceAliasOutput, error) { @@ -2591,7 +2677,7 @@ func (c *PrometheusService) UpdateWorkspaceAliasWithContext(ctx aws.Context, inp return out, req.Send() } -// User does not have sufficient access to perform this action. +// You do not have sufficient access to perform this action. type AccessDeniedException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2656,27 +2742,30 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } -// Represents the properties of an alert manager definition. +// The details of an alert manager definition. type AlertManagerDefinitionDescription struct { _ struct{} `type:"structure"` - // The time when the alert manager definition was created. + // The date and time that the alert manager definition was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The alert manager definition. + // The actual alert manager definition. + // + // For details about the alert manager definition, see AlertManagedDefinitionData + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The time when the alert manager definition was modified. + // The date and time that the alert manager definition was most recently changed. // // ModifiedAt is a required field ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"` - // The status of alert manager definition. + // A structure that displays the current status of the alert manager definition.. // // Status is a required field Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"` @@ -2724,16 +2813,16 @@ func (s *AlertManagerDefinitionDescription) SetStatus(v *AlertManagerDefinitionS return s } -// Represents the status of a definition. +// The status of the alert manager. type AlertManagerDefinitionStatus struct { _ struct{} `type:"structure"` - // Status code of this definition. + // The current status of the alert manager. // // StatusCode is a required field StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"AlertManagerDefinitionStatusCode"` - // The reason for failure if any. + // If there is a failure, the reason for the failure. StatusReason *string `locationName:"statusReason" type:"string"` } @@ -2767,11 +2856,12 @@ func (s *AlertManagerDefinitionStatus) SetStatusReason(v string) *AlertManagerDe return s } -// A representation of an AMP destination. +// The AmpConfiguration structure defines the Amazon Managed Service for Prometheus +// instance a scraper should send metrics to. type AmpConfiguration struct { _ struct{} `type:"structure"` - // The ARN of an AMP workspace. + // ARN of the Amazon Managed Service for Prometheus workspace. // // WorkspaceArn is a required field WorkspaceArn *string `locationName:"workspaceArn" type:"string" required:"true"` @@ -2814,7 +2904,7 @@ func (s *AmpConfiguration) SetWorkspaceArn(v string) *AmpConfiguration { return s } -// Updating or deleting a resource can cause an inconsistent state. +// The request would cause an inconsistent state. type ConflictException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -2893,17 +2983,21 @@ func (s *ConflictException) RequestID() string { type CreateAlertManagerDefinitionInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The alert manager definition 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 + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The ID of the workspace in which to create the alert manager definition. + // The ID of the workspace to add the alert manager definition to. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -2971,7 +3065,7 @@ func (s *CreateAlertManagerDefinitionInput) SetWorkspaceId(v string) *CreateAler type CreateAlertManagerDefinitionOutput struct { _ struct{} `type:"structure"` - // The status of alert manager definition. + // A structure that displays the current status of the alert manager definition. // // Status is a required field Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"` @@ -3005,16 +3099,17 @@ func (s *CreateAlertManagerDefinitionOutput) SetStatus(v *AlertManagerDefinition type CreateLoggingConfigurationInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // 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. // // LogGroupArn is a required field LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"` - // The ID of the workspace to vend logs to. + // The ID of the workspace to create the logging configuration for. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3082,7 +3177,7 @@ func (s *CreateLoggingConfigurationInput) SetWorkspaceId(v string) *CreateLoggin type CreateLoggingConfigurationOutput struct { _ struct{} `type:"structure"` - // The status of the logging configuration. + // A structure that displays the current status of the logging configuration. // // Status is a required field Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"` @@ -3116,25 +3211,30 @@ func (s *CreateLoggingConfigurationOutput) SetStatus(v *LoggingConfigurationStat type CreateRuleGroupsNamespaceInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The namespace data that define the rule groups. + // 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 + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The rule groups namespace name. + // The name for the new rule groups namespace. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // Optional, user-provided tags for this rule groups namespace. + // The list of tag keys and values to associate with the rule groups namespace. Tags map[string]*string `locationName:"tags" type:"map"` - // The ID of the workspace in which to create the rule group namespace. + // The ID of the workspace to add the rule groups namespace. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3220,22 +3320,22 @@ func (s *CreateRuleGroupsNamespaceInput) SetWorkspaceId(v string) *CreateRuleGro type CreateRuleGroupsNamespaceOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of this rule groups namespace. + // The Amazon Resource Name (ARN) of the new rule groups namespace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The rule groups namespace name. + // The name of the new rule groups namespace. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // The status of rule groups namespace. + // A structure that returns the current status of the rule groups namespace. // // Status is a required field Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this rule groups namespace. + // The list of tag keys and values that are associated with the namespace. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3285,30 +3385,32 @@ func (s *CreateRuleGroupsNamespaceOutput) SetTags(v map[string]*string) *CreateR type CreateScraperInput struct { _ struct{} `type:"structure"` - // 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. Alias *string `locationName:"alias" min:"1" type:"string"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The destination that the scraper will be producing metrics to. + // The Amazon Managed Service for Prometheus workspace to send metrics to. // // Destination is a required field Destination *Destination `locationName:"destination" type:"structure" required:"true"` - // The configuration used to create the scraper. + // 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. // // ScrapeConfiguration is a required field ScrapeConfiguration *ScrapeConfiguration `locationName:"scrapeConfiguration" type:"structure" required:"true"` - // The source that the scraper will be discovering and collecting metrics from. + // The Amazon EKS cluster from which the scraper will collect metrics. // // Source is a required field Source *Source `locationName:"source" type:"structure" required:"true"` - // Optional, user-provided tags for this scraper. + // (Optional) The list of tag keys and values to associate with the scraper. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3405,22 +3507,22 @@ func (s *CreateScraperInput) SetTags(v map[string]*string) *CreateScraperInput { type CreateScraperOutput struct { _ struct{} `type:"structure"` - // The ARN of the scraper that was just created. + // The Amazon Resource Name (ARN) of the new scraper. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The generated ID of the scraper that was just created. + // The ID of the new scraper. // // ScraperId is a required field ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"` - // The status of the scraper that was just created (usually CREATING). + // A structure that displays the current status of the scraper. // // Status is a required field Status *ScraperStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this scraper. + // The list of tag keys and values that are associated with the scraper. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3470,18 +3572,24 @@ func (s *CreateScraperOutput) SetTags(v map[string]*string) *CreateScraperOutput type CreateWorkspaceInput struct { _ struct{} `type:"structure"` - // 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. Alias *string `locationName:"alias" min:"1" type:"string"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // 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 (https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) + // in the Amazon Managed Service for Prometheus User Guide. KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` - // Optional, user-provided tags for this workspace. + // The list of tag keys and values to associate with the workspace. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -3550,23 +3658,25 @@ func (s *CreateWorkspaceInput) SetTags(v map[string]*string) *CreateWorkspaceInp type CreateWorkspaceOutput struct { _ struct{} `type:"structure"` - // The ARN of the workspace that was just created. + // The ARN for the new workspace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // Customer managed KMS key ARN for this workspace + // (optional) If the workspace was created with a customer managed KMS key, + // the ARN for the key used. KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` - // 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. // // Status is a required field Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this workspace. + // The list of tag keys and values that are associated with the workspace. Tags map[string]*string `locationName:"tags" type:"map"` - // The generated ID of the workspace that was just created. + // The unique ID for the new workspace. // // WorkspaceId is a required field WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3624,11 +3734,11 @@ func (s *CreateWorkspaceOutput) SetWorkspaceId(v string) *CreateWorkspaceOutput type DeleteAlertManagerDefinitionInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The ID of the workspace in which to delete the alert manager definition. + // The ID of the workspace to delete the alert manager definition from. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3709,11 +3819,11 @@ func (s DeleteAlertManagerDefinitionOutput) GoString() string { type DeleteLoggingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The ID of the workspace to vend logs to. + // The ID of the workspace containing the logging configuration to delete. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3794,16 +3904,17 @@ func (s DeleteLoggingConfigurationOutput) GoString() string { type DeleteRuleGroupsNamespaceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The rule groups namespace name. + // The name of the rule groups namespace to delete. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` - // The ID of the workspace to delete rule group definition. + // The ID of the workspace containing the rule groups namespace and definition + // to delete. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -3896,8 +4007,8 @@ func (s DeleteRuleGroupsNamespaceOutput) GoString() string { type DeleteScraperInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The ID of the scraper to delete. @@ -3959,12 +4070,12 @@ func (s *DeleteScraperInput) SetScraperId(v string) *DeleteScraperInput { type DeleteScraperOutput struct { _ struct{} `type:"structure"` - // The ID of the scraper that was deleted. + // The ID of the scraper to delete. // // ScraperId is a required field ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"` - // The status of the scraper that is being deleted. + // The current status of the scraper. // // Status is a required field Status *ScraperStatus `locationName:"status" type:"structure" required:"true"` @@ -4004,8 +4115,8 @@ func (s *DeleteScraperOutput) SetStatus(v *ScraperStatus) *DeleteScraperOutput { type DeleteWorkspaceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. ClientToken *string `location:"querystring" locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` // The ID of the workspace to delete. @@ -4089,7 +4200,7 @@ func (s DeleteWorkspaceOutput) GoString() string { type DescribeAlertManagerDefinitionInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The ID of the workspace to describe. + // The ID of the workspace to retrieve the alert manager definition from. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -4139,7 +4250,7 @@ func (s *DescribeAlertManagerDefinitionInput) SetWorkspaceId(v string) *Describe type DescribeAlertManagerDefinitionOutput struct { _ struct{} `type:"structure"` - // The properties of the selected workspace's alert manager definition. + // The alert manager definition. // // AlertManagerDefinition is a required field AlertManagerDefinition *AlertManagerDefinitionDescription `locationName:"alertManagerDefinition" type:"structure" required:"true"` @@ -4173,7 +4284,7 @@ func (s *DescribeAlertManagerDefinitionOutput) SetAlertManagerDefinition(v *Aler type DescribeLoggingConfigurationInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The ID of the workspace to vend logs to. + // The ID of the workspace to describe the logging configuration for. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -4223,8 +4334,7 @@ func (s *DescribeLoggingConfigurationInput) SetWorkspaceId(v string) *DescribeLo type DescribeLoggingConfigurationOutput struct { _ struct{} `type:"structure"` - // Metadata object containing information about the logging configuration of - // a workspace. + // A structure that displays the information about the logging configuration. // // LoggingConfiguration is a required field LoggingConfiguration *LoggingConfigurationMetadata `locationName:"loggingConfiguration" type:"structure" required:"true"` @@ -4258,12 +4368,12 @@ func (s *DescribeLoggingConfigurationOutput) SetLoggingConfiguration(v *LoggingC type DescribeRuleGroupsNamespaceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The rule groups namespace. + // The name of the rule groups namespace that you want information for. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` - // The ID of the workspace to describe. + // The ID of the workspace containing the rule groups namespace. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -4325,7 +4435,7 @@ func (s *DescribeRuleGroupsNamespaceInput) SetWorkspaceId(v string) *DescribeRul type DescribeRuleGroupsNamespaceOutput struct { _ struct{} `type:"structure"` - // The selected rule groups namespace. + // The information about the rule groups namespace. // // RuleGroupsNamespace is a required field RuleGroupsNamespace *RuleGroupsNamespaceDescription `locationName:"ruleGroupsNamespace" type:"structure" required:"true"` @@ -4359,7 +4469,7 @@ func (s *DescribeRuleGroupsNamespaceOutput) SetRuleGroupsNamespace(v *RuleGroups type DescribeScraperInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The IDs of the scraper to describe. + // The ID of the scraper to describe. // // ScraperId is a required field ScraperId *string `location:"uri" locationName:"scraperId" min:"1" type:"string" required:"true"` @@ -4409,7 +4519,7 @@ func (s *DescribeScraperInput) SetScraperId(v string) *DescribeScraperInput { type DescribeScraperOutput struct { _ struct{} `type:"structure"` - // The properties of the selected scrapers. + // Contains details about the scraper. // // Scraper is a required field Scraper *ScraperDescription `locationName:"scraper" type:"structure" required:"true"` @@ -4493,7 +4603,7 @@ func (s *DescribeWorkspaceInput) SetWorkspaceId(v string) *DescribeWorkspaceInpu type DescribeWorkspaceOutput struct { _ struct{} `type:"structure"` - // The properties of the selected workspace. + // A structure that contains details about the workspace. // // Workspace is a required field Workspace *WorkspaceDescription `locationName:"workspace" type:"structure" required:"true"` @@ -4523,11 +4633,11 @@ func (s *DescribeWorkspaceOutput) SetWorkspace(v *WorkspaceDescription) *Describ return s } -// A representation of a destination that a scraper can produce metrics to. +// Where to send the metrics from a scraper. type Destination struct { _ struct{} `type:"structure"` - // A representation of an AMP destination. + // The Amazon Managed Service for Prometheusworkspace to send metrics to. AmpConfiguration *AmpConfiguration `locationName:"ampConfiguration" type:"structure"` } @@ -4570,19 +4680,20 @@ func (s *Destination) SetAmpConfiguration(v *AmpConfiguration) *Destination { return s } -// A representation of an EKS source. +// The EksConfiguration structure describes the connection to the Amazon EKS +// cluster from which a scraper collects metrics. type EksConfiguration struct { _ struct{} `type:"structure"` - // The ARN of an EKS cluster. + // ARN of the Amazon EKS cluster. // // ClusterArn is a required field ClusterArn *string `locationName:"clusterArn" type:"string" required:"true"` - // A list of security group IDs specified for VPC configuration. + // A list of the security group IDs for the Amazon EKS cluster VPC configuration. SecurityGroupIds []*string `locationName:"securityGroupIds" min:"1" type:"list"` - // A list of subnet IDs specified for VPC configuration. + // A list of subnet IDs for the Amazon EKS cluster VPC configuration. // // SubnetIds is a required field SubnetIds []*string `locationName:"subnetIds" min:"1" type:"list" required:"true"` @@ -4673,7 +4784,9 @@ func (s GetDefaultScraperConfigurationInput) GoString() string { type GetDefaultScraperConfigurationOutput struct { _ struct{} `type:"structure"` - // The default configuration. + // The configuration file. Base 64 encoded. For more information, see Scraper + // configuration (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)in + // the Amazon Managed Service for Prometheus User Guide. // Configuration is automatically base64 encoded/decoded by the SDK. // // Configuration is a required field @@ -4704,7 +4817,7 @@ func (s *GetDefaultScraperConfigurationOutput) SetConfiguration(v []byte) *GetDe return s } -// Unexpected error during processing of request. +// An unexpected error occurred during the processing of the request. type InternalServerException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -4776,18 +4889,25 @@ func (s *InternalServerException) RequestID() string { type ListRuleGroupsNamespacesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // Maximum results to return in response (default=100, maximum=1000). + // The maximum number of results to return. The default is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // 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. Name *string `location:"querystring" locationName:"name" min:"1" type:"string"` - // 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. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` - // The ID of the workspace. + // The ID of the workspace containing the rule groups namespaces. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -4861,10 +4981,12 @@ func (s *ListRuleGroupsNamespacesInput) SetWorkspaceId(v string) *ListRuleGroups type ListRuleGroupsNamespacesOutput struct { _ struct{} `type:"structure"` - // 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. NextToken *string `locationName:"nextToken" type:"string"` - // The list of the selected rule groups namespaces. + // The returned list of rule groups namespaces. // // RuleGroupsNamespaces is a required field RuleGroupsNamespaces []*RuleGroupsNamespaceSummary `locationName:"ruleGroupsNamespaces" type:"list" required:"true"` @@ -4904,14 +5026,32 @@ func (s *ListRuleGroupsNamespacesOutput) SetRuleGroupsNamespaces(v []*RuleGroups type ListScrapersInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. + // + // 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. Filters map[string][]*string `location:"querystring" locationName:"filters" min:"1" type:"map"` - // 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. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // Pagination token to request the next page in a paginated list. This token - // is obtained from the output of the previous ListScrapers request. + // (Optional) The token for the next set of items to return. (You received this + // token from a previous call.) NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -4971,11 +5111,12 @@ func (s *ListScrapersInput) SetNextToken(v string) *ListScrapersInput { type ListScrapersOutput struct { _ struct{} `type:"structure"` - // 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. NextToken *string `locationName:"nextToken" type:"string"` - // The list of scrapers, filtered down if a set of filters was provided in the - // request. + // A list of ScraperSummary structures giving information about scrapers in + // the account that match the filters provided. // // Scrapers is a required field Scrapers []*ScraperSummary `locationName:"scrapers" type:"list" required:"true"` @@ -5014,7 +5155,8 @@ func (s *ListScrapersOutput) SetScrapers(v []*ScraperSummary) *ListScrapersOutpu type ListTagsForResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The ARN of the resource. + // The ARN of the resource to list tages for. Must be a workspace or rule groups + // namespace resource. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` @@ -5063,7 +5205,7 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` - // The list of tags assigned to the resource. + // The list of tag keys and values associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5095,15 +5237,23 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe type ListWorkspacesInput struct { _ struct{} `type:"structure" nopayload:"true"` - // 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. Alias *string `location:"querystring" locationName:"alias" min:"1" type:"string"` - // Maximum results to return in response (default=100, maximum=1000). + // The maximum number of workspaces to return per request. The default is 100. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // Pagination token to request the next page in a paginated list. This token - // is obtained from the output of the previous ListWorkspaces 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 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. NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` } @@ -5163,10 +5313,12 @@ func (s *ListWorkspacesInput) SetNextToken(v string) *ListWorkspacesInput { type ListWorkspacesOutput struct { _ struct{} `type:"structure"` - // 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. NextToken *string `locationName:"nextToken" type:"string"` - // The list of existing workspaces, including those undergoing creation or deletion. + // An array of WorkspaceSummary structures containing information about the + // workspaces requested. // // Workspaces is a required field Workspaces []*WorkspaceSummary `locationName:"workspaces" type:"list" required:"true"` @@ -5202,31 +5354,32 @@ func (s *ListWorkspacesOutput) SetWorkspaces(v []*WorkspaceSummary) *ListWorkspa return s } -// Represents the properties of a logging configuration metadata. +// Contains information about the logging configuration. type LoggingConfigurationMetadata struct { _ struct{} `type:"structure"` - // The time when the logging configuration was created. + // The date and time that the logging configuration was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // 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. // // LogGroupArn is a required field LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"` - // The time when the logging configuration was modified. + // The date and time that the logging configuration was most recently changed. // // ModifiedAt is a required field ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"` - // The status of the logging configuration. + // The current status of the logging configuration. // // Status is a required field Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"` - // The workspace where the logging configuration exists. + // The ID of the workspace the logging configuration is for. // // Workspace is a required field Workspace *string `locationName:"workspace" min:"1" type:"string" required:"true"` @@ -5280,16 +5433,16 @@ func (s *LoggingConfigurationMetadata) SetWorkspace(v string) *LoggingConfigurat return s } -// Represents the status of a logging configuration. +// The status of the logging configuration. type LoggingConfigurationStatus struct { _ struct{} `type:"structure"` - // Status code of the logging configuration. + // The current status of the logging configuration. // // StatusCode is a required field StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"LoggingConfigurationStatusCode"` - // The reason for failure if any. + // If failed, the reason for the failure. StatusReason *string `locationName:"statusReason" type:"string"` } @@ -5327,17 +5480,21 @@ func (s *LoggingConfigurationStatus) SetStatusReason(v string) *LoggingConfigura type PutAlertManagerDefinitionInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The alert manager definition 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 + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The ID of the workspace in which to update the alert manager definition. + // The ID of the workspace to update the alert manager definition in. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -5405,7 +5562,7 @@ func (s *PutAlertManagerDefinitionInput) SetWorkspaceId(v string) *PutAlertManag type PutAlertManagerDefinitionOutput struct { _ struct{} `type:"structure"` - // The status of alert manager definition. + // A structure that returns the current status of the alert manager definition. // // Status is a required field Status *AlertManagerDefinitionStatus `locationName:"status" type:"structure" required:"true"` @@ -5439,22 +5596,26 @@ func (s *PutAlertManagerDefinitionOutput) SetStatus(v *AlertManagerDefinitionSta type PutRuleGroupsNamespaceInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // 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 + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The rule groups namespace name. + // The name of the rule groups namespace that you are updating. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` - // The ID of the workspace in which to update the rule group namespace. + // The ID of the workspace where you are updating the rule groups namespace. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -5534,22 +5695,22 @@ func (s *PutRuleGroupsNamespaceInput) SetWorkspaceId(v string) *PutRuleGroupsNam type PutRuleGroupsNamespaceOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of this rule groups namespace. + // The ARN of the rule groups namespace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The rule groups namespace name. + // The name of the rule groups namespace that was updated. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // The status of rule groups namespace. + // A structure that includes the current status of the rule groups namespace. // // Status is a required field Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this rule groups namespace. + // The list of tag keys and values that are associated with the namespace. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5595,7 +5756,7 @@ func (s *PutRuleGroupsNamespaceOutput) SetTags(v map[string]*string) *PutRuleGro return s } -// Request references a resource which does not exist. +// The request references a resources that doesn't exist. type ResourceNotFoundException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -5670,42 +5831,46 @@ func (s *ResourceNotFoundException) RequestID() string { return s.RespMetadata.RequestID } -// Represents a description of the rule groups namespace. +// The details about one rule groups namespace. type RuleGroupsNamespaceDescription struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of this rule groups namespace. + // The ARN of the rule groups namespace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the rule groups namespace was created. + // The date and time that the rule groups namespace was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The rule groups namespace data. + // The rule groups file used in the namespace. + // + // For details about the rule groups namespace structure, see RuleGroupsNamespaceData + // (https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html). // Data is automatically base64 encoded/decoded by the SDK. // // Data is a required field Data []byte `locationName:"data" type:"blob" required:"true"` - // The time when the rule groups namespace was modified. + // The date and time that the rule groups namespace was most recently changed. // // ModifiedAt is a required field ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"` - // The rule groups namespace name. + // The name of the rule groups namespace. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // The status of rule groups namespace. + // The current status of the rule groups namespace. // // Status is a required field Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this rule groups namespace. + // The list of tag keys and values that are associated with the rule groups + // namespace. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5769,16 +5934,16 @@ func (s *RuleGroupsNamespaceDescription) SetTags(v map[string]*string) *RuleGrou return s } -// Represents the status of a namespace. +// The status information about a rule groups namespace. type RuleGroupsNamespaceStatus struct { _ struct{} `type:"structure"` - // Status code of this namespace. + // The current status of the namespace. // // StatusCode is a required field StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"RuleGroupsNamespaceStatusCode"` - // The reason for failure if any. + // The reason for the failure, if any. StatusReason *string `locationName:"statusReason" type:"string"` } @@ -5812,36 +5977,38 @@ func (s *RuleGroupsNamespaceStatus) SetStatusReason(v string) *RuleGroupsNamespa return s } -// Represents a summary of the rule groups namespace. +// The high-level information about a rule groups namespace. To retrieve more +// information, use DescribeRuleGroupsNamespace. type RuleGroupsNamespaceSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of this rule groups namespace. + // The ARN of the rule groups namespace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the rule groups namespace was created. + // The date and time that the rule groups namespace was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The time when the rule groups namespace was modified. + // The date and time that the rule groups namespace was most recently changed. // // ModifiedAt is a required field ModifiedAt *time.Time `locationName:"modifiedAt" type:"timestamp" required:"true"` - // The rule groups namespace name. + // The name of the rule groups namespace. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` - // The status of rule groups namespace. + // A structure that displays the current status of the rule groups namespace. // // Status is a required field Status *RuleGroupsNamespaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this rule groups namespace. + // The list of tag keys and values that are associated with the rule groups + // namespace. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -5899,11 +6066,13 @@ func (s *RuleGroupsNamespaceSummary) SetTags(v map[string]*string) *RuleGroupsNa return s } -// 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. type ScrapeConfiguration struct { _ struct{} `type:"structure"` - // Binary data representing a Prometheus configuration file. + // The base 64 encoded scrape configuration file. // ConfigurationBlob is automatically base64 encoded/decoded by the SDK. ConfigurationBlob []byte `locationName:"configurationBlob" type:"blob"` } @@ -5932,63 +6101,65 @@ func (s *ScrapeConfiguration) SetConfigurationBlob(v []byte) *ScrapeConfiguratio return s } -// Represents the properties of a scraper. +// The ScraperDescription structure contains the full details about one scraper +// in your account. type ScraperDescription struct { _ struct{} `type:"structure"` - // Alias of this scraper. + // (Optional) A name associated with the scraper. Alias *string `locationName:"alias" min:"1" type:"string"` - // The Amazon Resource Name (ARN) of this scraper. + // The Amazon Resource Name (ARN) of the scraper. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the scraper was created. + // The date and time that the scraper was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The destination that the scraper is producing metrics to. + // The Amazon Managed Service for Prometheus workspace the scraper sends metrics + // to. // // Destination is a required field Destination *Destination `locationName:"destination" type:"structure" required:"true"` - // The time when the scraper was last modified. + // The date and time that the scraper was last modified. // // LastModifiedAt is a required field LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp" required:"true"` // The Amazon Resource Name (ARN) of the IAM role that provides permissions - // for the scraper to dsicover, collect, and produce metrics on your behalf. + // for the scraper to discover and collect metrics on your behalf. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // The configuration used to create the scraper. + // The configuration file in use by the scraper. // // ScrapeConfiguration is a required field ScrapeConfiguration *ScrapeConfiguration `locationName:"scrapeConfiguration" type:"structure" required:"true"` - // Unique string identifying this scraper. + // The ID of the scraper. // // ScraperId is a required field ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"` - // The source that the scraper is discovering and collecting metrics from. + // The Amazon EKS cluster from which the scraper collects metrics. // // Source is a required field Source *Source `locationName:"source" type:"structure" required:"true"` - // The status of this scraper. + // A structure that contains the current status of the scraper. // // Status is a required field Status *ScraperStatus `locationName:"status" type:"structure" required:"true"` - // The reason for failure if any. + // If there is a failure, the reason for the failure. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` - // The tags of this scraper. + // (Optional) The list of tag keys and values associated with the scraper. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6082,11 +6253,11 @@ func (s *ScraperDescription) SetTags(v map[string]*string) *ScraperDescription { return s } -// Represents the status of a scraper. +// The ScraperStatus structure contains status information about the scraper. type ScraperStatus struct { _ struct{} `type:"structure"` - // Status code of this scraper. + // The current status of the scraper. // // StatusCode is a required field StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"ScraperStatusCode"` @@ -6116,58 +6287,60 @@ func (s *ScraperStatus) SetStatusCode(v string) *ScraperStatus { return s } -// Represents a summary of the properties of a scraper. +// The ScraperSummary structure contains a summary of the details about one +// scraper in your account. type ScraperSummary struct { _ struct{} `type:"structure"` - // Alias of this scraper. + // (Optional) A name associated with the scraper. Alias *string `locationName:"alias" min:"1" type:"string"` - // The Amazon Resource Name (ARN) of this scraper. + // The Amazon Resource Name (ARN) of the scraper. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the scraper was created. + // The date and time that the scraper was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The destination that the scraper is producing metrics to. + // The Amazon Managed Service for Prometheus workspace the scraper sends metrics + // to. // // Destination is a required field Destination *Destination `locationName:"destination" type:"structure" required:"true"` - // The time when the scraper was last modified. + // The date and time that the scraper was last modified. // // LastModifiedAt is a required field LastModifiedAt *time.Time `locationName:"lastModifiedAt" type:"timestamp" required:"true"` // The Amazon Resource Name (ARN) of the IAM role that provides permissions - // for the scraper to dsicover, collect, and produce metrics on your behalf. + // for the scraper to discover and collect metrics on your behalf. // // RoleArn is a required field RoleArn *string `locationName:"roleArn" type:"string" required:"true"` - // Unique string identifying this scraper. + // The ID of the scraper. // // ScraperId is a required field ScraperId *string `locationName:"scraperId" min:"1" type:"string" required:"true"` - // The source that the scraper is discovering and collecting metrics from. + // The Amazon EKS cluster from which the scraper collects metrics. // // Source is a required field Source *Source `locationName:"source" type:"structure" required:"true"` - // The status of this scraper. + // A structure that contains the current status of the scraper. // // Status is a required field Status *ScraperStatus `locationName:"status" type:"structure" required:"true"` - // The reason for failure if any. + // If there is a failure, the reason for the failure. StatusReason *string `locationName:"statusReason" min:"1" type:"string"` - // The tags of this scraper. + // (Optional) The list of tag keys and values associated with the scraper. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -6255,7 +6428,7 @@ func (s *ScraperSummary) SetTags(v map[string]*string) *ScraperSummary { return s } -// Request would cause a service quota to be exceeded. +// Completing the request would cause a service quota to be exceeded. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6263,7 +6436,7 @@ type ServiceQuotaExceededException struct { // Description of the error. Message_ *string `locationName:"message" type:"string"` - // Service Quotas requirement to identify originating quota. + // Service quotas code of the originating quota. // // QuotaCode is a required field QuotaCode *string `locationName:"quotaCode" type:"string" required:"true"` @@ -6278,7 +6451,7 @@ type ServiceQuotaExceededException struct { // ResourceType is a required field ResourceType *string `locationName:"resourceType" type:"string" required:"true"` - // Service Quotas requirement to identify originating service. + // Service quotas code for the originating service. // // ServiceCode is a required field ServiceCode *string `locationName:"serviceCode" type:"string" required:"true"` @@ -6340,12 +6513,11 @@ func (s *ServiceQuotaExceededException) RequestID() string { return s.RespMetadata.RequestID } -// A representation of a source that a scraper can discover and collect metrics -// from. +// The source of collected metrics for a scraper. type Source struct { _ struct{} `type:"structure"` - // A representation of an EKS source. + // The Amazon EKS cluster from which a scraper collects metrics. EksConfiguration *EksConfiguration `locationName:"eksConfiguration" type:"structure"` } @@ -6391,12 +6563,14 @@ func (s *Source) SetEksConfiguration(v *EksConfiguration) *Source { type TagResourceInput struct { _ struct{} `type:"structure"` - // The ARN of the resource. + // The ARN of the workspace or rule groups namespace to apply tags to. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` - // 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:. // // Tags is a required field Tags map[string]*string `locationName:"tags" type:"map" required:"true"` @@ -6473,7 +6647,7 @@ func (s TagResourceOutput) GoString() string { return s.String() } -// Request was denied due to request throttling. +// The request was denied due to request throttling. type ThrottlingException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -6481,13 +6655,13 @@ type ThrottlingException struct { // Description of the error. Message_ *string `locationName:"message" type:"string"` - // Service Quotas requirement to identify originating quota. + // Service quotas code for the originating quota. QuotaCode *string `locationName:"quotaCode" type:"string"` // Advice to clients on when the call can be safely retried. RetryAfterSeconds *int64 `location:"header" locationName:"Retry-After" type:"integer"` - // Service Quotas requirement to identify originating service. + // Service quotas code for the originating service. ServiceCode *string `locationName:"serviceCode" type:"string"` } @@ -6550,12 +6724,12 @@ func (s *ThrottlingException) RequestID() string { type UntagResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The ARN of the resource. + // The ARN of the workspace or rule groups namespace. // // ResourceArn is a required field ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` - // One or more tag keys + // The keys of the tags to remove. // // TagKeys is a required field TagKeys []*string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` @@ -6636,16 +6810,17 @@ func (s UntagResourceOutput) GoString() string { type UpdateLoggingConfigurationInput struct { _ struct{} `type:"structure"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // 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. // // LogGroupArn is a required field LogGroupArn *string `locationName:"logGroupArn" type:"string" required:"true"` - // The ID of the workspace to vend logs to. + // The ID of the workspace to update the logging configuration for. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -6713,7 +6888,7 @@ func (s *UpdateLoggingConfigurationInput) SetWorkspaceId(v string) *UpdateLoggin type UpdateLoggingConfigurationOutput struct { _ struct{} `type:"structure"` - // The status of the logging configuration. + // A structure that contains the current status of the logging configuration. // // Status is a required field Status *LoggingConfigurationStatus `locationName:"status" type:"structure" required:"true"` @@ -6747,14 +6922,17 @@ func (s *UpdateLoggingConfigurationOutput) SetStatus(v *LoggingConfigurationStat type UpdateWorkspaceAliasInput struct { _ struct{} `type:"structure"` - // 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. Alias *string `locationName:"alias" min:"1" type:"string"` - // 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. ClientToken *string `locationName:"clientToken" min:"1" type:"string" idempotencyToken:"true"` - // The ID of the workspace being updated. + // The ID of the workspace to update. // // WorkspaceId is a required field WorkspaceId *string `location:"uri" locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -6840,13 +7018,13 @@ func (s UpdateWorkspaceAliasOutput) GoString() string { return s.String() } -// 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. type ValidationException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The field that caused the error, if applicable. If more than one field caused - // the error, pick one and elaborate in the message. + // The field that caused the error, if applicable. FieldList []*ValidationExceptionField `locationName:"fieldList" type:"list"` // Description of the error. @@ -6914,17 +7092,16 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } -// 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. type ValidationExceptionField struct { _ struct{} `type:"structure"` - // Message describing why the field failed validation. + // A message describing why the field caused an exception. // // Message is a required field Message *string `locationName:"message" type:"string" required:"true"` - // The field name. + // The name of the field that caused an exception. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` @@ -6960,38 +7137,41 @@ func (s *ValidationExceptionField) SetName(v string) *ValidationExceptionField { return s } -// Represents the properties of a workspace. +// The full details about one Amazon Managed Service for Prometheus workspace +// in your account. type WorkspaceDescription struct { _ struct{} `type:"structure"` - // Alias of this workspace. + // The alias that is assigned to this workspace to help identify it. It may + // not be unique. Alias *string `locationName:"alias" min:"1" type:"string"` - // The Amazon Resource Name (ARN) of this workspace. + // The ARN of the workspace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the workspace was created. + // The date and time that the workspace was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // The customer managed KMS key of this workspace. + // (optional) If the workspace was created with a customer managed KMS key, + // the ARN for the key used. KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` - // Prometheus endpoint URI. + // The Prometheus endpoint available for this workspace. PrometheusEndpoint *string `locationName:"prometheusEndpoint" min:"1" type:"string"` - // The status of this workspace. + // The current status of the workspace. // // Status is a required field Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this workspace. + // The list of tag keys and values that are associated with the workspace. Tags map[string]*string `locationName:"tags" type:"map"` - // Unique string identifying this workspace. + // The unique ID for the workspace. // // WorkspaceId is a required field WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -7063,11 +7243,11 @@ func (s *WorkspaceDescription) SetWorkspaceId(v string) *WorkspaceDescription { return s } -// Represents the status of a workspace. +// The status of the workspace. type WorkspaceStatus struct { _ struct{} `type:"structure"` - // Status code of this workspace. + // The current status of the workspace. // // StatusCode is a required field StatusCode *string `locationName:"statusCode" type:"string" required:"true" enum:"WorkspaceStatusCode"` @@ -7097,35 +7277,38 @@ func (s *WorkspaceStatus) SetStatusCode(v string) *WorkspaceStatus { return s } -// Represents a summary of the properties of a workspace. +// The information about one Amazon Managed Service for Prometheus workspace +// in your account. type WorkspaceSummary struct { _ struct{} `type:"structure"` - // Alias of this workspace. + // The alias that is assigned to this workspace to help identify it. It may + // not be unique. Alias *string `locationName:"alias" min:"1" type:"string"` - // The AmazonResourceName of this workspace. + // The ARN of the workspace. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The time when the workspace was created. + // The date and time that the workspace was created. // // CreatedAt is a required field CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" required:"true"` - // Customer managed KMS key ARN for this workspace + // (optional) If the workspace was created with a customer managed KMS key, + // the ARN for the key used. KmsKeyArn *string `locationName:"kmsKeyArn" min:"20" type:"string"` - // The status of this workspace. + // The current status of the workspace. // // Status is a required field Status *WorkspaceStatus `locationName:"status" type:"structure" required:"true"` - // The tags of this workspace. + // The list of tag keys and values that are associated with the workspace. Tags map[string]*string `locationName:"tags" type:"map"` - // Unique string identifying this workspace. + // The unique ID for the workspace. // // WorkspaceId is a required field WorkspaceId *string `locationName:"workspaceId" min:"1" type:"string" required:"true"` @@ -7191,7 +7374,7 @@ func (s *WorkspaceSummary) SetWorkspaceId(v string) *WorkspaceSummary { return s } -// State of an alert manager definition. +// State of an AlertManagerDefinition. const ( // AlertManagerDefinitionStatusCodeCreating is a AlertManagerDefinitionStatusCode enum value AlertManagerDefinitionStatusCodeCreating = "CREATING" diff --git a/service/prometheusservice/doc.go b/service/prometheusservice/doc.go index ddc0939acf5..4b9b61be607 100644 --- a/service/prometheusservice/doc.go +++ b/service/prometheusservice/doc.go @@ -3,7 +3,26 @@ // Package prometheusservice provides the client and types for making API // requests to Amazon Prometheus Service. // -// # Amazon Managed Service for Prometheus +// 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 (https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html) +// User Guide. +// +// Amazon Managed Service for Prometheus includes two APIs. +// +// - Use the Amazon Web Services API described in this guide to manage Amazon +// Managed Service for Prometheus resources, such as workspaces, rule groups, +// and alert managers. +// +// - Use the Prometheus-compatible API (https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-APIReference.html#AMP-APIReference-Prometheus-Compatible-Apis) +// to work within your Prometheus workspace. // // See https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01 for more information on this service. // diff --git a/service/prometheusservice/errors.go b/service/prometheusservice/errors.go index 4256cb3efff..9a2a3de064a 100644 --- a/service/prometheusservice/errors.go +++ b/service/prometheusservice/errors.go @@ -11,43 +11,44 @@ const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // - // User does not have sufficient access to perform this action. + // You do not have sufficient access to perform this action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeConflictException for service response error code // "ConflictException". // - // Updating or deleting a resource can cause an inconsistent state. + // The request would cause an inconsistent state. ErrCodeConflictException = "ConflictException" // ErrCodeInternalServerException for service response error code // "InternalServerException". // - // Unexpected error during processing of request. + // An unexpected error occurred during the processing of the request. ErrCodeInternalServerException = "InternalServerException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // - // Request references a resource which does not exist. + // The request references a resources that doesn't exist. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeServiceQuotaExceededException for service response error code // "ServiceQuotaExceededException". // - // Request would cause a service quota to be exceeded. + // Completing the request would cause a service quota to be exceeded. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" // ErrCodeThrottlingException for service response error code // "ThrottlingException". // - // Request was denied due to request throttling. + // The request was denied due to request throttling. ErrCodeThrottlingException = "ThrottlingException" // ErrCodeValidationException for service response error code // "ValidationException". // - // 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. ErrCodeValidationException = "ValidationException" )