Create an alert manager definition.
", + "documentation":"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.
Create logging configuration.
", + "documentation":"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.
Create a rule group namespace.
", + "documentation":"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.
Create a scraper.
", + "documentation":"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.
Creates a new AMP workspace.
", + "documentation":"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.
", "idempotent":true }, "DeleteAlertManagerDefinition":{ @@ -129,7 +129,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes an alert manager definition.
", + "documentation":"Deletes the alert manager definition from a workspace.
", "idempotent":true }, "DeleteLoggingConfiguration":{ @@ -147,7 +147,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Delete logging configuration.
", + "documentation":"Deletes the logging configuration for a workspace.
", "idempotent":true }, "DeleteRuleGroupsNamespace":{ @@ -166,7 +166,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Delete a rule groups namespace.
", + "documentation":"Deletes one rule groups namespace and its associated rule groups definition.
", "idempotent":true }, "DeleteScraper":{ @@ -186,7 +186,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes a scraper.
", + "documentation":"The DeleteScraper operation deletes one scraper, and stops any metrics collection that the scraper performs.
Deletes an AMP workspace.
", + "documentation":"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.
Describes an alert manager definition.
" + "documentation":"Retrieves the full information about the alert manager definition for a workspace.
" }, "DescribeLoggingConfiguration":{ "name":"DescribeLoggingConfiguration", @@ -241,7 +241,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Describes logging configuration.
" + "documentation":"Returns complete information about the current logging configuration of the workspace.
" }, "DescribeRuleGroupsNamespace":{ "name":"DescribeRuleGroupsNamespace", @@ -259,7 +259,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Describe a rule groups namespace.
" + "documentation":"Returns complete information about one rule groups namespace. To retrieve a list of rule groups namespaces, use ListRuleGroupsNamespaces.
Describe an existing scraper.
" + "documentation":"The DescribeScraper operation displays information about an existing scraper.
Describes an existing AMP workspace.
" + "documentation":"Returns information about an existing workspace.
" }, "GetDefaultScraperConfiguration":{ "name":"GetDefaultScraperConfiguration", @@ -311,7 +311,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Gets a default configuration.
" + "documentation":"The GetDefaultScraperConfiguration operation returns the default scraper configuration used when Amazon EKS creates a scraper for you.
Lists rule groups namespaces.
" + "documentation":"Returns a list of rule groups namespaces in a workspace.
" }, "ListScrapers":{ "name":"ListScrapers", @@ -346,7 +346,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"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.
" + "documentation":"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.
Lists the tags you have assigned to the resource.
" + "documentation":"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.
Lists all AMP workspaces, including workspaces being created or deleted.
" + "documentation":"Lists all of the Amazon Managed Service for Prometheus workspaces in your account. This includes workspaces being created or deleted.
" }, "PutAlertManagerDefinition":{ "name":"PutAlertManagerDefinition", @@ -401,7 +401,7 @@ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Update an alert manager definition.
", + "documentation":"Updates an existing alert manager definition in a workspace. If the workspace does not already have an alert manager definition, don't use this operation to create it. Instead, use CreateAlertManagerDefinition.
Update a rule groups namespace.
", + "documentation":"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.
Creates tags for the specified resource.
" + "documentation":"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":{ "name":"UntagResource", @@ -459,7 +459,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Deletes tags from the specified resource.
", + "documentation":"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.
", "idempotent":true }, "UpdateLoggingConfiguration":{ @@ -478,7 +478,7 @@ {"shape":"AccessDeniedException"}, {"shape":"InternalServerException"} ], - "documentation":"Update logging configuration.
", + "documentation":"Updates the log group ARN or the workspace ID of the current logging configuration.
", "idempotent":true }, "UpdateWorkspaceAlias":{ @@ -498,7 +498,7 @@ {"shape":"InternalServerException"}, {"shape":"ServiceQuotaExceededException"} ], - "documentation":"Updates an AMP workspace alias.
", + "documentation":"Updates the alias of an existing workspace.
", "idempotent":true } }, @@ -512,7 +512,7 @@ "documentation":"Description of the error.
" } }, - "documentation":"User does not have sufficient access to perform this action.
", + "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true @@ -521,35 +521,35 @@ }, "AlertManagerDefinitionData":{ "type":"blob", - "documentation":"The alert manager definition data.
" + "documentation":"The base-64 encoded blob that is alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
" }, "AlertManagerDefinitionDescription":{ "type":"structure", "required":[ - "status", - "data", "createdAt", - "modifiedAt" + "data", + "modifiedAt", + "status" ], "members":{ - "status":{ - "shape":"AlertManagerDefinitionStatus", - "documentation":"The status of alert manager definition.
" + "createdAt":{ + "shape":"Timestamp", + "documentation":"The date and time that the alert manager definition was created.
" }, "data":{ "shape":"AlertManagerDefinitionData", - "documentation":"The alert manager definition.
" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The time when the alert manager definition was created.
" + "documentation":"The actual alert manager definition.
For details about the alert manager definition, see AlertManagedDefinitionData.
" }, "modifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the alert manager definition was modified.
" + "documentation":"The date and time that the alert manager definition was most recently changed.
" + }, + "status":{ + "shape":"AlertManagerDefinitionStatus", + "documentation":"A structure that displays the current status of the alert manager definition..
" } }, - "documentation":"Represents the properties of an alert manager definition.
" + "documentation":"The details of an alert manager definition.
" }, "AlertManagerDefinitionStatus":{ "type":"structure", @@ -557,18 +557,18 @@ "members":{ "statusCode":{ "shape":"AlertManagerDefinitionStatusCode", - "documentation":"Status code of this definition.
" + "documentation":"The current status of the alert manager.
" }, "statusReason":{ "shape":"String", - "documentation":"The reason for failure if any.
" + "documentation":"If there is a failure, the reason for the failure.
" } }, - "documentation":"Represents the status of a definition.
" + "documentation":"The status of the alert manager.
" }, "AlertManagerDefinitionStatusCode":{ "type":"string", - "documentation":"State of an alert manager definition.
", + "documentation":"State of an AlertManagerDefinition.
The ARN of an AMP workspace.
" + "documentation":"ARN of the Amazon Managed Service for Prometheus workspace.
" } }, - "documentation":"A representation of an AMP destination.
" + "documentation":"The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
The ARN of an EKS cluster.
", - "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", @@ -616,7 +616,7 @@ "documentation":"Type of the resource affected.
" } }, - "documentation":"Updating or deleting a resource can cause an inconsistent state.
", + "documentation":"The request would cause an inconsistent state.
", "error":{ "httpStatusCode":409, "senderFault":true @@ -626,27 +626,27 @@ "CreateAlertManagerDefinitionRequest":{ "type":"structure", "required":[ - "workspaceId", - "data" + "data", + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "documentation":"The ID of the workspace in which to create the alert manager definition.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true }, "data":{ "shape":"AlertManagerDefinitionData", - "documentation":"The alert manager definition data.
" + "documentation":"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.
" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to add the alert manager definition to.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a CreateAlertManagerDefinition operation.
" + "documentation":"Represents the input of a CreateAlertManagerDefinition operation.
The status of alert manager definition.
" + "documentation":"A structure that displays the current status of the alert manager definition.
" } }, - "documentation":"Represents the output of a CreateAlertManagerDefinition operation.
" + "documentation":"Represents the output of a CreateAlertManagerDefinition operation.
The ID of the workspace to vend logs to.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true }, "logGroupArn":{ "shape":"LogGroupArn", - "documentation":"The ARN of the CW log group to which the vended log data will be published.
" + "documentation":"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.
" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to create the logging configuration for.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a CreateLoggingConfiguration operation.
" + "documentation":"Represents the input of a CreateLoggingConfiguration operation.
The status of the logging configuration.
" + "documentation":"A structure that displays the current status of the logging configuration.
" } }, - "documentation":"Represents the output of a CreateLoggingConfiguration operation.
" + "documentation":"Represents the output of a CreateLoggingConfiguration operation.
The ID of the workspace in which to create the rule group namespace.
", - "location":"uri", - "locationName":"workspaceId" - }, - "name":{ - "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace name.
" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true }, "data":{ "shape":"RuleGroupsNamespaceData", - "documentation":"The namespace data that define the rule groups.
" + "documentation":"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.
" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "name":{ + "shape":"RuleGroupsNamespaceName", + "documentation":"The name for the new rule groups namespace.
" }, "tags":{ "shape":"TagMap", - "documentation":"Optional, user-provided tags for this rule groups namespace.
" + "documentation":"The list of tag keys and values to associate with the rule groups namespace.
" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to add the rule groups namespace.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a CreateRuleGroupsNamespace operation.
" + "documentation":"Represents the input of a CreateRuleGroupsNamespace operation.
The rule groups namespace name.
" - }, "arn":{ "shape":"RuleGroupsNamespaceArn", - "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" + "documentation":"The Amazon Resource Name (ARN) of the new rule groups namespace.
" + }, + "name":{ + "shape":"RuleGroupsNamespaceName", + "documentation":"The name of the new rule groups namespace.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", - "documentation":"The status of rule groups namespace.
" + "documentation":"A structure that returns the current status of the rule groups namespace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this rule groups namespace.
" + "documentation":"The list of tag keys and values that are associated with the namespace.
" } }, - "documentation":"Represents the output of a CreateRuleGroupsNamespace operation.
" + "documentation":"Represents the output of a CreateRuleGroupsNamespace operation.
An optional user-assigned alias for this scraper. This alias is for user reference and does not need to be unique.
" + "documentation":"(optional) a name to associate with the scraper. This is for your use, and does not need to be unique.
" + }, + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", + "idempotencyToken":true + }, + "destination":{ + "shape":"Destination", + "documentation":"The Amazon Managed Service for Prometheus workspace to send metrics to.
" }, "scrapeConfiguration":{ "shape":"ScrapeConfiguration", - "documentation":"The configuration used to create the scraper.
" + "documentation":"The configuration file to use in the new scraper. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
" }, "source":{ "shape":"Source", - "documentation":"The source that the scraper will be discovering and collecting metrics from.
" - }, - "destination":{ - "shape":"Destination", - "documentation":"The destination that the scraper will be producing metrics to.
" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "documentation":"The Amazon EKS cluster from which the scraper will collect metrics.
" }, "tags":{ "shape":"TagMap", - "documentation":"Optional, user-provided tags for this scraper.
" + "documentation":"(Optional) The list of tag keys and values to associate with the scraper.
" } }, - "documentation":"Represents the input of a CreateScraper operation.
" + "documentation":"Represents the input of a CreateScraper operation.
The generated ID of the scraper that was just created.
" - }, "arn":{ "shape":"ScraperArn", - "documentation":"The ARN of the scraper that was just created.
" + "documentation":"The Amazon Resource Name (ARN) of the new scraper.
" + }, + "scraperId":{ + "shape":"ScraperId", + "documentation":"The ID of the new scraper.
" }, "status":{ "shape":"ScraperStatus", - "documentation":"The status of the scraper that was just created (usually CREATING).
" + "documentation":"A structure that displays the current status of the scraper.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this scraper.
" + "documentation":"The list of tag keys and values that are associated with the scraper.
" } }, - "documentation":"Represents the output of a CreateScraper operation.
" + "documentation":"Represents the output of a CreateScraper operation.
An optional user-assigned alias for this workspace. This alias is for user reference and does not need to be unique.
" + "documentation":"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.
" }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken":true }, - "tags":{ - "shape":"TagMap", - "documentation":"Optional, user-provided tags for this workspace.
" - }, "kmsKeyArn":{ "shape":"KmsKeyArn", - "documentation":"Optional, customer managed KMS key used to encrypt data for this workspace
" + "documentation":"(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.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"The list of tag keys and values to associate with the workspace.
" } }, - "documentation":"Represents the input of a CreateWorkspace operation.
" + "documentation":"Represents the input of a CreateWorkspace operation.
The generated ID of the workspace that was just created.
" - }, "arn":{ "shape":"WorkspaceArn", - "documentation":"The ARN of the workspace that was just created.
" + "documentation":"The ARN for the new workspace.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" }, "status":{ "shape":"WorkspaceStatus", - "documentation":"The status of the workspace that was just created (usually CREATING).
" + "documentation":"The current status of the new workspace. Immediately after you create the workspace, the status is usually CREATING.
The tags of this workspace.
" + "documentation":"The list of tag keys and values that are associated with the workspace.
" }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"Customer managed KMS key ARN for this workspace
" + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The unique ID for the new workspace.
" } }, - "documentation":"Represents the output of a CreateWorkspace operation.
" + "documentation":"Represents the output of a CreateWorkspace operation.
The ID of the workspace in which to delete the alert manager definition.
", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to delete the alert manager definition from.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DeleteAlertManagerDefinition operation.
" + "documentation":"Represents the input of a DeleteAlertManagerDefinition operation.
The ID of the workspace to vend logs to.
", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace containing the logging configuration to delete.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DeleteLoggingConfiguration operation.
" + "documentation":"Represents the input of a DeleteLoggingConfiguration operation.
The ID of the workspace to delete rule group definition.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true, + "location":"querystring", + "locationName":"clientToken" }, "name":{ "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace name.
", + "documentation":"The name of the rule groups namespace to delete.
", "location":"uri", "locationName":"name" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true, - "location":"querystring", - "locationName":"clientToken" + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace containing the rule groups namespace and definition to delete.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DeleteRuleGroupsNamespace operation.
" + "documentation":"Represents the input of a DeleteRuleGroupsNamespace operation.
The ID of the scraper to delete.
", - "location":"uri", - "locationName":"scraperId" - }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"(Optional) A unique, case-sensitive identifier that you can provide to ensure the idempotency of the request.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "scraperId":{ + "shape":"ScraperId", + "documentation":"The ID of the scraper to delete.
", + "location":"uri", + "locationName":"scraperId" } }, - "documentation":"Represents the input of a DeleteScraper operation.
" + "documentation":"Represents the input of a DeleteScraper operation.
The ID of the scraper that was deleted.
" + "documentation":"The ID of the scraper to delete.
" }, "status":{ "shape":"ScraperStatus", - "documentation":"The status of the scraper that is being deleted.
" + "documentation":"The current status of the scraper.
" } }, - "documentation":"Represents the output of a DeleteScraper operation.
" + "documentation":"Represents the output of a DeleteScraper operation.
The ID of the workspace to delete.
", - "location":"uri", - "locationName":"workspaceId" - }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to delete.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DeleteWorkspace operation.
" + "documentation":"Represents the input of a DeleteWorkspace operation.
The ID of the workspace to describe.
", + "documentation":"The ID of the workspace to retrieve the alert manager definition from.
", "location":"uri", "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DescribeAlertManagerDefinition operation.
" + "documentation":"Represents the input of a DescribeAlertManagerDefinition operation.
The properties of the selected workspace's alert manager definition.
" + "documentation":"The alert manager definition.
" } }, - "documentation":"Represents the output of a DescribeAlertManagerDefinition operation.
" + "documentation":"Represents the output of a DescribeAlertManagerDefinition operation.
The ID of the workspace to vend logs to.
", + "documentation":"The ID of the workspace to describe the logging configuration for.
", "location":"uri", "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DescribeLoggingConfiguration operation.
" + "documentation":"Represents the input of a DescribeLoggingConfiguration operation.
Metadata object containing information about the logging configuration of a workspace.
" + "documentation":"A structure that displays the information about the logging configuration.
" } }, - "documentation":"Represents the output of a DescribeLoggingConfiguration operation.
" + "documentation":"Represents the output of a DescribeLoggingConfiguration operation.
The ID of the workspace to describe.
", - "location":"uri", - "locationName":"workspaceId" - }, "name":{ "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace.
", + "documentation":"The name of the rule groups namespace that you want information for.
", "location":"uri", "locationName":"name" + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace containing the rule groups namespace.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a DescribeRuleGroupsNamespace operation.
" + "documentation":"Represents the input of a DescribeRuleGroupsNamespace operation.
The selected rule groups namespace.
" + "documentation":"The information about the rule groups namespace.
" } }, - "documentation":"Represents the output of a DescribeRuleGroupsNamespace operation.
" + "documentation":"Represents the output of a DescribeRuleGroupsNamespace operation.
The IDs of the scraper to describe.
", + "documentation":"The ID of the scraper to describe.
", "location":"uri", "locationName":"scraperId" } }, - "documentation":"Represents the input of a DescribeScraper operation.
" + "documentation":"Represents the input of a DescribeScraper operation.
The properties of the selected scrapers.
" + "documentation":"Contains details about the scraper.
" } }, - "documentation":"Represents the output of a DescribeScraper operation.
" + "documentation":"Represents the output of a DescribeScraper operation.
Represents the input of a DescribeWorkspace operation.
" + "documentation":"Represents the input of a DescribeWorkspace operation.
The properties of the selected workspace.
" + "documentation":"A structure that contains details about the workspace.
" } }, - "documentation":"Represents the output of a DescribeWorkspace operation.
" + "documentation":"Represents the output of a DescribeWorkspace operation.
A representation of an AMP destination.
" + "documentation":"The Amazon Managed Service for Prometheusworkspace to send metrics to.
" } }, - "documentation":"A representation of a destination that a scraper can produce metrics to.
", + "documentation":"Where to send the metrics from a scraper.
", "union":true }, "EksConfiguration":{ @@ -1149,28 +1149,28 @@ "members":{ "clusterArn":{ "shape":"ClusterArn", - "documentation":"The ARN of an EKS cluster.
" + "documentation":"ARN of the Amazon EKS cluster.
" }, "securityGroupIds":{ "shape":"SecurityGroupIds", - "documentation":"A list of security group IDs specified for VPC configuration.
" + "documentation":"A list of the security group IDs for the Amazon EKS cluster VPC configuration.
" }, "subnetIds":{ "shape":"SubnetIds", - "documentation":"A list of subnet IDs specified for VPC configuration.
" + "documentation":"A list of subnet IDs for the Amazon EKS cluster VPC configuration.
" } }, - "documentation":"A representation of an EKS source.
" + "documentation":"The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.
The name of the key to filter by.
", + "documentation":"The name of the key by which to filter.
", "max":256, "min":1 }, "FilterValue":{ "type":"string", - "documentation":"The value of a given key to filter by.
", + "documentation":"The value for a given key by which to filter.
", "max":256, "min":1 }, @@ -1185,7 +1185,7 @@ "type":"structure", "members":{ }, - "documentation":"Represents the input of a GetDefaultScraperConfiguration operation.
" + "documentation":"Represents the input of a GetDefaultScraperConfiguration operation.
The default configuration.
" + "documentation":"The configuration file. Base 64 encoded. For more information, see Scraper configurationin the Amazon Managed Service for Prometheus User Guide.
" } }, - "documentation":"Represents the output of a GetDefaultScraperConfiguration operation.
" + "documentation":"Represents the output of a GetDefaultScraperConfiguration operation.
An identifier used to ensure the idempotency of a write request.
", "max":64, "min":1, - "pattern":"[!-~]+" + "pattern":"^[!-~]+$" }, "Integer":{ "type":"integer", @@ -1228,7 +1228,7 @@ "locationName":"Retry-After" } }, - "documentation":"Unexpected error during processing of request.
", + "documentation":"An unexpected error occurred during the processing of the request.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true, @@ -1239,38 +1239,38 @@ "documentation":"A KMS Key ARN.
", "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", - "documentation":"The ID of the workspace.
", - "location":"uri", - "locationName":"workspaceId" + "maxResults":{ + "shape":"ListRuleGroupsNamespacesRequestMaxResultsInteger", + "documentation":"The maximum number of results to return. The default is 100.
", + "location":"querystring", + "locationName":"maxResults" }, "name":{ "shape":"RuleGroupsNamespaceName", - "documentation":"Optional filter for rule groups namespace name. Only the rule groups namespace that begin with this value will be returned.
", + "documentation":"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.
", "location":"querystring", "locationName":"name" }, "nextToken":{ "shape":"PaginationToken", - "documentation":"Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListRuleGroupsNamespaces request.
", + "documentation":"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.
Maximum results to return in response (default=100, maximum=1000).
", - "location":"querystring", - "locationName":"maxResults" + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace containing the rule groups namespaces.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a ListRuleGroupsNamespaces operation.
" + "documentation":"Represents the input of a ListRuleGroupsNamespaces operation.
The list of the selected rule groups namespaces.
" - }, "nextToken":{ "shape":"PaginationToken", - "documentation":"Pagination token to use when requesting the next page in this list.
" + "documentation":"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.
The returned list of rule groups namespaces.
" } }, - "documentation":"Represents the output of a ListRuleGroupsNamespaces operation.
" + "documentation":"Represents the output of a ListRuleGroupsNamespaces operation.
A list of scraper filters.
", + "documentation":"(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.
", "location":"querystring" }, - "nextToken":{ - "shape":"PaginationToken", - "documentation":"Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListScrapers request.
", - "location":"querystring", - "locationName":"nextToken" - }, "maxResults":{ "shape":"ListScrapersRequestMaxResultsInteger", - "documentation":"Maximum results to return in response (default=100, maximum=1000).
", + "documentation":"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.
", "location":"querystring", "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"(Optional) The token for the next set of items to return. (You received this token from a previous call.)
", + "location":"querystring", + "locationName":"nextToken" } }, - "documentation":"Represents the input of a ListScrapers operation.
" + "documentation":"Represents the input of a ListScrapers operation.
The list of scrapers, filtered down if a set of filters was provided in the request.
" - }, "nextToken":{ "shape":"PaginationToken", - "documentation":"Pagination token to use when requesting the next page in this list.
" + "documentation":"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.
A list of ScraperSummary structures giving information about scrapers in the account that match the filters provided.
Represents the output of a ListScrapers operation.
" + "documentation":"Represents the output of a ListScrapers operation.
The ARN of the resource.
", + "documentation":"The ARN of the resource to list tages for. Must be a workspace or rule groups namespace resource.
", "location":"uri", "locationName":"resourceArn" } @@ -1352,32 +1352,35 @@ "ListTagsForResourceResponse":{ "type":"structure", "members":{ - "tags":{"shape":"TagMap"} + "tags":{ + "shape":"TagMap", + "documentation":"The list of tag keys and values associated with the resource.
" + } } }, "ListWorkspacesRequest":{ "type":"structure", "members":{ - "nextToken":{ - "shape":"PaginationToken", - "documentation":"Pagination token to request the next page in a paginated list. This token is obtained from the output of the previous ListWorkspaces request.
", - "location":"querystring", - "locationName":"nextToken" - }, "alias":{ "shape":"WorkspaceAlias", - "documentation":"Optional filter for workspace alias. Only the workspaces with aliases that begin with this value will be returned.
", + "documentation":"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.
", "location":"querystring", "locationName":"alias" }, "maxResults":{ "shape":"ListWorkspacesRequestMaxResultsInteger", - "documentation":"Maximum results to return in response (default=100, maximum=1000).
", + "documentation":"The maximum number of workspaces to return per request. The default is 100.
", "location":"querystring", "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"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.
Represents the input of a ListWorkspaces operation.
" + "documentation":"Represents the input of a ListWorkspaces operation.
The list of existing workspaces, including those undergoing creation or deletion.
" - }, "nextToken":{ "shape":"PaginationToken", - "documentation":"Pagination token to use when requesting the next page in this list.
" + "documentation":"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.
An array of WorkspaceSummary structures containing information about the workspaces requested.
Represents the output of a ListWorkspaces operation.
" + "documentation":"Represents the output of a ListWorkspaces operation.
The status of the logging configuration.
" - }, - "workspace":{ - "shape":"WorkspaceId", - "documentation":"The workspace where the logging configuration exists.
" - }, - "logGroupArn":{ - "shape":"LogGroupArn", - "documentation":"The ARN of the CW log group to which the vended log data will be published.
" - }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time when the logging configuration was created.
" + "documentation":"The date and time that the logging configuration was created.
" + }, + "logGroupArn":{ + "shape":"LogGroupArn", + "documentation":"The ARN of the CloudWatch log group to which the vended log data will be published.
" }, "modifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the logging configuration was modified.
" + "documentation":"The date and time that the logging configuration was most recently changed.
" + }, + "status":{ + "shape":"LoggingConfigurationStatus", + "documentation":"The current status of the logging configuration.
" + }, + "workspace":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace the logging configuration is for.
" } }, - "documentation":"Represents the properties of a logging configuration metadata.
" + "documentation":"Contains information about the logging configuration.
" }, "LoggingConfigurationStatus":{ "type":"structure", @@ -1443,14 +1446,14 @@ "members":{ "statusCode":{ "shape":"LoggingConfigurationStatusCode", - "documentation":"Status code of the logging configuration.
" + "documentation":"The current status of the logging configuration.
" }, "statusReason":{ "shape":"String", - "documentation":"The reason for failure if any.
" + "documentation":"If failed, the reason for the failure.
" } }, - "documentation":"Represents the status of a logging configuration.
" + "documentation":"The status of the logging configuration.
" }, "LoggingConfigurationStatusCode":{ "type":"string", @@ -1473,27 +1476,27 @@ "PutAlertManagerDefinitionRequest":{ "type":"structure", "required":[ - "workspaceId", - "data" + "data", + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "documentation":"The ID of the workspace in which to update the alert manager definition.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true }, "data":{ "shape":"AlertManagerDefinitionData", - "documentation":"The alert manager definition data.
" + "documentation":"The alert manager definition to use. A base64-encoded version of the YAML alert manager definition file.
For details about the alert manager definition, see AlertManagedDefinitionData.
" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to update the alert manager definition in.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a PutAlertManagerDefinition operation.
" + "documentation":"Represents the input of a PutAlertManagerDefinition operation.
The status of alert manager definition.
" + "documentation":"A structure that returns the current status of the alert manager definition.
" } }, - "documentation":"Represents the output of a PutAlertManagerDefinition operation.
" + "documentation":"Represents the output of a PutAlertManagerDefinition operation.
The ID of the workspace in which to update the rule group namespace.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true + }, + "data":{ + "shape":"RuleGroupsNamespaceData", + "documentation":"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.
" }, "name":{ "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace name.
", + "documentation":"The name of the rule groups namespace that you are updating.
", "location":"uri", "locationName":"name" }, - "data":{ - "shape":"RuleGroupsNamespaceData", - "documentation":"The namespace data that define the rule groups.
" - }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace where you are updating the rule groups namespace.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of a PutRuleGroupsNamespace operation.
" + "documentation":"Represents the input of a PutRuleGroupsNamespace operation.
The rule groups namespace name.
" - }, "arn":{ "shape":"RuleGroupsNamespaceArn", - "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" + "documentation":"The ARN of the rule groups namespace.
" + }, + "name":{ + "shape":"RuleGroupsNamespaceName", + "documentation":"The name of the rule groups namespace that was updated.
" }, "status":{ "shape":"RuleGroupsNamespaceStatus", - "documentation":"The status of rule groups namespace.
" + "documentation":"A structure that includes the current status of the rule groups namespace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this rule groups namespace.
" + "documentation":"The list of tag keys and values that are associated with the namespace.
" } }, - "documentation":"Represents the output of a PutRuleGroupsNamespace operation.
" + "documentation":"Represents the output of a PutRuleGroupsNamespace operation.
Type of the resource affected.
" } }, - "documentation":"Request references a resource which does not exist.
", + "documentation":"The request references a resources that doesn't exist.
", "error":{ "httpStatusCode":404, "senderFault":true @@ -1605,50 +1608,50 @@ "type":"structure", "required":[ "arn", - "name", - "status", - "data", "createdAt", - "modifiedAt" + "data", + "modifiedAt", + "name", + "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", - "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" - }, - "name":{ - "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace name.
" + "documentation":"The ARN of the rule groups namespace.
" }, - "status":{ - "shape":"RuleGroupsNamespaceStatus", - "documentation":"The status of rule groups namespace.
" + "createdAt":{ + "shape":"Timestamp", + "documentation":"The date and time that the rule groups namespace was created.
" }, "data":{ "shape":"RuleGroupsNamespaceData", - "documentation":"The rule groups namespace data.
" - }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The time when the rule groups namespace was created.
" + "documentation":"The rule groups file used in the namespace.
For details about the rule groups namespace structure, see RuleGroupsNamespaceData.
" }, "modifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the rule groups namespace was modified.
" + "documentation":"The date and time that the rule groups namespace was most recently changed.
" + }, + "name":{ + "shape":"RuleGroupsNamespaceName", + "documentation":"The name of the rule groups namespace.
" + }, + "status":{ + "shape":"RuleGroupsNamespaceStatus", + "documentation":"The current status of the rule groups namespace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this rule groups namespace.
" + "documentation":"The list of tag keys and values that are associated with the rule groups namespace.
" } }, - "documentation":"Represents a description of the rule groups namespace.
" + "documentation":"The details about one rule groups namespace.
" }, "RuleGroupsNamespaceName":{ "type":"string", - "documentation":"The namespace name that the rule group belong to.
", + "documentation":"The name of the namespace that the rule group belong to.
", "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", @@ -1656,14 +1659,14 @@ "members":{ "statusCode":{ "shape":"RuleGroupsNamespaceStatusCode", - "documentation":"Status code of this namespace.
" + "documentation":"The current status of the namespace.
" }, "statusReason":{ "shape":"String", - "documentation":"The reason for failure if any.
" + "documentation":"The reason for the failure, if any.
" } }, - "documentation":"Represents the status of a namespace.
" + "documentation":"The status information about a rule groups namespace.
" }, "RuleGroupsNamespaceStatusCode":{ "type":"string", @@ -1681,38 +1684,38 @@ "type":"structure", "required":[ "arn", - "name", - "status", "createdAt", - "modifiedAt" + "modifiedAt", + "name", + "status" ], "members":{ "arn":{ "shape":"RuleGroupsNamespaceArn", - "documentation":"The Amazon Resource Name (ARN) of this rule groups namespace.
" - }, - "name":{ - "shape":"RuleGroupsNamespaceName", - "documentation":"The rule groups namespace name.
" - }, - "status":{ - "shape":"RuleGroupsNamespaceStatus", - "documentation":"The status of rule groups namespace.
" + "documentation":"The ARN of the rule groups namespace.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time when the rule groups namespace was created.
" + "documentation":"The date and time that the rule groups namespace was created.
" }, "modifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the rule groups namespace was modified.
" + "documentation":"The date and time that the rule groups namespace was most recently changed.
" + }, + "name":{ + "shape":"RuleGroupsNamespaceName", + "documentation":"The name of the rule groups namespace.
" + }, + "status":{ + "shape":"RuleGroupsNamespaceStatus", + "documentation":"A structure that displays the current status of the rule groups namespace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this rule groups namespace.
" + "documentation":"The list of tag keys and values that are associated with the rule groups namespace.
" } }, - "documentation":"Represents a summary of the rule groups namespace.
" + "documentation":"The high-level information about a rule groups namespace. To retrieve more information, use DescribeRuleGroupsNamespace.
Binary data representing a Prometheus configuration file.
" + "documentation":"The base 64 encoded scrape configuration file.
" } }, - "documentation":"A representation of a Prometheus configuration file.
", + "documentation":"A scrape configuration for a scraper, base 64 encoded. For more information, see Scraper configuration in the Amazon Managed Service for Prometheus User Guide.
", "union":true }, "ScraperAlias":{ @@ -1735,7 +1738,7 @@ "documentation":"A user-assigned scraper alias.
", "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", @@ -1744,77 +1747,77 @@ "ScraperDescription":{ "type":"structure", "required":[ - "scraperId", "arn", - "roleArn", - "status", "createdAt", + "destination", "lastModifiedAt", + "roleArn", "scrapeConfiguration", + "scraperId", "source", - "destination" + "status" ], "members":{ "alias":{ "shape":"ScraperAlias", - "documentation":"Alias of this scraper.
" - }, - "scraperId":{ - "shape":"ScraperId", - "documentation":"Unique string identifying this scraper.
" + "documentation":"(Optional) A name associated with the scraper.
" }, "arn":{ "shape":"ScraperArn", - "documentation":"The Amazon Resource Name (ARN) of this scraper.
" - }, - "roleArn":{ - "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
" - }, - "status":{ - "shape":"ScraperStatus", - "documentation":"The status of this scraper.
" + "documentation":"The Amazon Resource Name (ARN) of the scraper.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time when the scraper was created.
" + "documentation":"The date and time that the scraper was created.
" + }, + "destination":{ + "shape":"Destination", + "documentation":"The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
" }, "lastModifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the scraper was last modified.
" - }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of this scraper.
" + "documentation":"The date and time that the scraper was last modified.
" }, - "statusReason":{ - "shape":"StatusReason", - "documentation":"The reason for failure if any.
" + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
" }, "scrapeConfiguration":{ "shape":"ScrapeConfiguration", - "documentation":"The configuration used to create the scraper.
" + "documentation":"The configuration file in use by the scraper.
" + }, + "scraperId":{ + "shape":"ScraperId", + "documentation":"The ID of the scraper.
" }, "source":{ "shape":"Source", - "documentation":"The source that the scraper is discovering and collecting metrics from.
" + "documentation":"The Amazon EKS cluster from which the scraper collects metrics.
" }, - "destination":{ - "shape":"Destination", - "documentation":"The destination that the scraper is producing metrics to.
" + "status":{ + "shape":"ScraperStatus", + "documentation":"A structure that contains the current status of the scraper.
" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"If there is a failure, the reason for the failure.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"(Optional) The list of tag keys and values associated with the scraper.
" } }, - "documentation":"Represents the properties of a scraper.
" + "documentation":"The ScraperDescription structure contains the full details about one scraper in your account.
The name of the key to filter by. Currently supported filter keys are 'status', 'sourceArn', 'destinationArn', and 'alias'.
" + "documentation":"The name of the key to filter by. Currently supported filter keys are status, sourceArn, destinationArn, and alias.
The values of the given key to filter by.
" + "documentation":"The values of the given key by which to filter.
" }, "documentation":"A list of scraper filters.
", "max":4, @@ -1825,7 +1828,7 @@ "documentation":"A scraper ID.
", "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", @@ -1833,10 +1836,10 @@ "members":{ "statusCode":{ "shape":"ScraperStatusCode", - "documentation":"Status code of this scraper.
" + "documentation":"The current status of the scraper.
" } }, - "documentation":"Represents the status of a scraper.
" + "documentation":"The ScraperStatus structure contains status information about the scraper.
Alias of this scraper.
" - }, - "scraperId":{ - "shape":"ScraperId", - "documentation":"Unique string identifying this scraper.
" + "documentation":"(Optional) A name associated with the scraper.
" }, "arn":{ "shape":"ScraperArn", - "documentation":"The Amazon Resource Name (ARN) of this scraper.
" - }, - "roleArn":{ - "shape":"IamRoleArn", - "documentation":"The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to dsicover, collect, and produce metrics on your behalf.
" - }, - "status":{ - "shape":"ScraperStatus", - "documentation":"The status of this scraper.
" + "documentation":"The Amazon Resource Name (ARN) of the scraper.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time when the scraper was created.
" + "documentation":"The date and time that the scraper was created.
" + }, + "destination":{ + "shape":"Destination", + "documentation":"The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
" }, "lastModifiedAt":{ "shape":"Timestamp", - "documentation":"The time when the scraper was last modified.
" + "documentation":"The date and time that the scraper was last modified.
" }, - "tags":{ - "shape":"TagMap", - "documentation":"The tags of this scraper.
" + "roleArn":{ + "shape":"IamRoleArn", + "documentation":"The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf.
" }, - "statusReason":{ - "shape":"StatusReason", - "documentation":"The reason for failure if any.
" + "scraperId":{ + "shape":"ScraperId", + "documentation":"The ID of the scraper.
" }, "source":{ "shape":"Source", - "documentation":"The source that the scraper is discovering and collecting metrics from.
" + "documentation":"The Amazon EKS cluster from which the scraper collects metrics.
" }, - "destination":{ - "shape":"Destination", - "documentation":"The destination that the scraper is producing metrics to.
" + "status":{ + "shape":"ScraperStatus", + "documentation":"A structure that contains the current status of the scraper.
" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"If there is a failure, the reason for the failure.
" + }, + "tags":{ + "shape":"TagMap", + "documentation":"(Optional) The list of tag keys and values associated with the scraper.
" } }, - "documentation":"Represents a summary of the properties of a scraper.
" + "documentation":"The ScraperSummary structure contains a summary of the details about one scraper in your account.
ID of a VPC security group.
", "max":255, "min":0, - "pattern":"sg-[0-9a-z]+" + "pattern":"^sg-[0-9a-z]+$" }, "SecurityGroupIds":{ "type":"list", @@ -1932,16 +1935,20 @@ "type":"structure", "required":[ "message", + "quotaCode", "resourceId", "resourceType", - "serviceCode", - "quotaCode" + "serviceCode" ], "members":{ "message":{ "shape":"String", "documentation":"Description of the error.
" }, + "quotaCode":{ + "shape":"String", + "documentation":"Service quotas code of the originating quota.
" + }, "resourceId":{ "shape":"String", "documentation":"Identifier of the resource affected.
" @@ -1952,14 +1959,10 @@ }, "serviceCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating service.
" - }, - "quotaCode":{ - "shape":"String", - "documentation":"Service Quotas requirement to identify originating quota.
" + "documentation":"Service quotas code for the originating service.
" } }, - "documentation":"Request would cause a service quota to be exceeded.
", + "documentation":"Completing the request would cause a service quota to be exceeded.
", "error":{ "httpStatusCode":402, "senderFault":true @@ -1971,15 +1974,15 @@ "members":{ "eksConfiguration":{ "shape":"EksConfiguration", - "documentation":"A representation of an EKS source.
" + "documentation":"The Amazon EKS cluster from which a scraper collects metrics.
" } }, - "documentation":"A representation of a source that a scraper can discover and collect metrics from.
", + "documentation":"The source of collected metrics for a scraper.
", "union":true }, "StatusReason":{ "type":"string", - "documentation":"The reason for failure if any.
", + "documentation":"The reason for the failure, if any.
", "max":256, "min":1 }, @@ -1989,7 +1992,7 @@ "documentation":"ID of a VPC subnet.
", "max":255, "min":0, - "pattern":"subnet-[0-9a-z]+" + "pattern":"^subnet-[0-9a-z]+$" }, "SubnetIds":{ "type":"list", @@ -2002,7 +2005,7 @@ "type":"string", "max":128, "min":1, - "pattern":"([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)" + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "TagKeys":{ "type":"list", @@ -2012,11 +2015,11 @@ "type":"map", "key":{ "shape":"TagKey", - "documentation":"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:.
The key of the tag. May not begin with aws:.
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: _ . : / = + - @
" + "documentation":"The value of the tag.
" }, "documentation":"The list of tags assigned to the resource.
", "max":50, @@ -2031,11 +2034,14 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"The ARN of the resource.
", + "documentation":"The ARN of the workspace or rule groups namespace to apply tags to.
", "location":"uri", "locationName":"resourceArn" }, - "tags":{"shape":"TagMap"} + "tags":{ + "shape":"TagMap", + "documentation":"The list of tag keys and values to associate with the resource.
Keys may not begin with aws:.
Description of the error.
" }, - "serviceCode":{ - "shape":"String", - "documentation":"Service Quotas requirement to identify originating service.
" - }, "quotaCode":{ "shape":"String", - "documentation":"Service Quotas requirement to identify originating quota.
" + "documentation":"Service quotas code for the originating quota.
" }, "retryAfterSeconds":{ "shape":"Integer", "documentation":"Advice to clients on when the call can be safely retried.
", "location":"header", "locationName":"Retry-After" + }, + "serviceCode":{ + "shape":"String", + "documentation":"Service quotas code for the originating service.
" } }, - "documentation":"Request was denied due to request throttling.
", + "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true @@ -2090,13 +2096,13 @@ "members":{ "resourceArn":{ "shape":"String", - "documentation":"The ARN of the resource.
", + "documentation":"The ARN of the workspace or rule groups namespace.
", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeys", - "documentation":"One or more tag keys
", + "documentation":"The keys of the tags to remove.
", "location":"querystring", "locationName":"tagKeys" } @@ -2110,27 +2116,27 @@ "UpdateLoggingConfigurationRequest":{ "type":"structure", "required":[ - "workspaceId", - "logGroupArn" + "logGroupArn", + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "documentation":"The ID of the workspace to vend logs to.
", - "location":"uri", - "locationName":"workspaceId" + "clientToken":{ + "shape":"IdempotencyToken", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", + "idempotencyToken":true }, "logGroupArn":{ "shape":"LogGroupArn", - "documentation":"The ARN of the CW log group to which the vended log data will be published.
" + "documentation":"The ARN of the CloudWatch log group to which the vended log data will be published.
" }, - "clientToken":{ - "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", - "idempotencyToken":true + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to update the logging configuration for.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of an UpdateLoggingConfiguration operation.
" + "documentation":"Represents the input of an UpdateLoggingConfiguration operation.
The status of the logging configuration.
" + "documentation":"A structure that contains the current status of the logging configuration.
" } }, - "documentation":"Represents the output of an UpdateLoggingConfiguration operation.
" + "documentation":"Represents the output of an UpdateLoggingConfiguration operation.
The ID of the workspace being updated.
", - "location":"uri", - "locationName":"workspaceId" - }, "alias":{ "shape":"WorkspaceAlias", - "documentation":"The new alias of the workspace.
" + "documentation":"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.
" }, "clientToken":{ "shape":"IdempotencyToken", - "documentation":"Optional, unique, case-sensitive, user-provided identifier to ensure the idempotency of the request.
", + "documentation":"A unique identifier that you can provide to ensure the idempotency of the request. Case-sensitive.
", "idempotencyToken":true + }, + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The ID of the workspace to update.
", + "location":"uri", + "locationName":"workspaceId" } }, - "documentation":"Represents the input of an UpdateWorkspaceAlias operation.
" + "documentation":"Represents the input of an UpdateWorkspaceAlias operation.
The field that caused the error, if applicable.
" + }, "message":{ "shape":"String", "documentation":"Description of the error.
" @@ -2184,13 +2194,9 @@ "reason":{ "shape":"ValidationExceptionReason", "documentation":"Reason the request failed validation.
" - }, - "fieldList":{ - "shape":"ValidationExceptionFieldList", - "documentation":"The field that caused the error, if applicable. If more than one field caused the error, pick one and elaborate in the message.
" } }, - "documentation":"The input fails to satisfy the constraints specified by an AWS service.
", + "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "error":{ "httpStatusCode":400, "senderFault":true @@ -2200,20 +2206,20 @@ "ValidationExceptionField":{ "type":"structure", "required":[ - "name", - "message" + "message", + "name" ], "members":{ - "name":{ + "message":{ "shape":"String", - "documentation":"The field name.
" + "documentation":"A message describing why the field caused an exception.
" }, - "message":{ + "name":{ "shape":"String", - "documentation":"Message describing why the field failed validation.
" + "documentation":"The name of the field that caused an exception.
" } }, - "documentation":"Stores information about a field passed inside a request that resulted in an exception.
" + "documentation":"Information about a field passed into a request that resulted in an exception.
" }, "ValidationExceptionFieldList":{ "type":"list", @@ -2239,58 +2245,58 @@ "WorkspaceArn":{ "type":"string", "documentation":"An ARN identifying a Workspace.
", - "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", - "documentation":"Unique string identifying this workspace.
" - }, "alias":{ "shape":"WorkspaceAlias", - "documentation":"Alias of this workspace.
" + "documentation":"The alias that is assigned to this workspace to help identify it. It may not be unique.
" }, "arn":{ "shape":"WorkspaceArn", - "documentation":"The Amazon Resource Name (ARN) of this workspace.
" + "documentation":"The ARN of the workspace.
" }, - "status":{ - "shape":"WorkspaceStatus", - "documentation":"The status of this workspace.
" + "createdAt":{ + "shape":"Timestamp", + "documentation":"The date and time that the workspace was created.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" }, "prometheusEndpoint":{ "shape":"Uri", - "documentation":"Prometheus endpoint URI.
" + "documentation":"The Prometheus endpoint available for this workspace.
" }, - "createdAt":{ - "shape":"Timestamp", - "documentation":"The time when the workspace was created.
" + "status":{ + "shape":"WorkspaceStatus", + "documentation":"The current status of the workspace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this workspace.
" + "documentation":"The list of tag keys and values that are associated with the workspace.
" }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"The customer managed KMS key of this workspace.
" + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The unique ID for the workspace.
" } }, - "documentation":"Represents the properties of a workspace.
" + "documentation":"The full details about one Amazon Managed Service for Prometheus workspace in your account.
" }, "WorkspaceId":{ "type":"string", "documentation":"A workspace ID.
", "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", @@ -2298,10 +2304,10 @@ "members":{ "statusCode":{ "shape":"WorkspaceStatusCode", - "documentation":"Status code of this workspace.
" + "documentation":"The current status of the workspace.
" } }, - "documentation":"Represents the status of a workspace.
" + "documentation":"The status of the workspace.
" }, "WorkspaceStatusCode":{ "type":"string", @@ -2317,42 +2323,42 @@ "WorkspaceSummary":{ "type":"structure", "required":[ - "workspaceId", "arn", + "createdAt", "status", - "createdAt" + "workspaceId" ], "members":{ - "workspaceId":{ - "shape":"WorkspaceId", - "documentation":"Unique string identifying this workspace.
" - }, "alias":{ "shape":"WorkspaceAlias", - "documentation":"Alias of this workspace.
" + "documentation":"The alias that is assigned to this workspace to help identify it. It may not be unique.
" }, "arn":{ "shape":"WorkspaceArn", - "documentation":"The AmazonResourceName of this workspace.
" - }, - "status":{ - "shape":"WorkspaceStatus", - "documentation":"The status of this workspace.
" + "documentation":"The ARN of the workspace.
" }, "createdAt":{ "shape":"Timestamp", - "documentation":"The time when the workspace was created.
" + "documentation":"The date and time that the workspace was created.
" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"(optional) If the workspace was created with a customer managed KMS key, the ARN for the key used.
" + }, + "status":{ + "shape":"WorkspaceStatus", + "documentation":"The current status of the workspace.
" }, "tags":{ "shape":"TagMap", - "documentation":"The tags of this workspace.
" + "documentation":"The list of tag keys and values that are associated with the workspace.
" }, - "kmsKeyArn":{ - "shape":"KmsKeyArn", - "documentation":"Customer managed KMS key ARN for this workspace
" + "workspaceId":{ + "shape":"WorkspaceId", + "documentation":"The unique ID for the workspace.
" } }, - "documentation":"Represents a summary of the properties of a workspace.
" + "documentation":"The information about one Amazon Managed Service for Prometheus workspace in your account.
" }, "WorkspaceSummaryList":{ "type":"list", @@ -2360,5 +2366,5 @@ "documentation":"A list of workspace summaries.
" } }, - "documentation":"Amazon Managed Service for Prometheus
" + "documentation":"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.
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 to work within your Prometheus workspace.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
" }, - "runtimePlatform":{"shape":"RuntimePlatform"} + "runtimePlatform":{ + "shape":"RuntimePlatform", + "documentation":"An object that represents the compute environment architecture for Batch jobs on Fargate.
" + }, + "repositoryCredentials":{ + "shape":"RepositoryCredentials", + "documentation":"The private repository authentication credentials to use.
" + } }, "documentation":"An object that represents the details of a container that's part of a job.
" }, @@ -956,7 +963,7 @@ "members":{ "image":{ "shape":"String", - "documentation":"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.
Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .
Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
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.
Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .
Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.
" }, - "runtimePlatform":{"shape":"RuntimePlatform"} + "runtimePlatform":{ + "shape":"RuntimePlatform", + "documentation":"An object that represents the compute environment architecture for Batch jobs on Fargate.
" + }, + "repositoryCredentials":{ + "shape":"RepositoryCredentials", + "documentation":"The private repository authentication credentials to use.
" + } }, "documentation":"Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.
" }, @@ -1302,7 +1316,7 @@ "members":{ "jobDefinitions":{ "shape":"StringList", - "documentation":"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}.
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.
The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.
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.
Amazon Linux 2: Default for all non-GPU instance families.
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.
Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
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.
Amazon Linux 2: Default for all non-GPU instance families.
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.
The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.
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.
Amazon Linux 2: Default for all non-GPU instance families.
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.
Amazon Linux 2023: Batch supports Amazon Linux 2023.
Amazon Linux 2023 does not support A1 instances.
Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
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.
Amazon Linux 2: Default for all non-GPU instance families.
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.
The name of the node for this job.
" }, - "metadata":{"shape":"EksMetadata"} + "metadata":{ + "shape":"EksMetadata", + "documentation":"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.
The details for the pod.
" }, @@ -2053,7 +2070,7 @@ }, "computeReservation":{ "shape":"Integer", - "documentation":"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.
" + "documentation":"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.
" }, "shareDistribution":{ "shape":"ShareAttributesList", @@ -2274,7 +2291,7 @@ }, "startedAt":{ "shape":"Long", - "documentation":"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.
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.
The name of the volume to mount.
" } }, - "documentation":"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.
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.
The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
" + } + }, + "documentation":"The repository credentials for private registry authentication.
" + }, "ResourceRequirement":{ "type":"structure", "required":[ @@ -3033,14 +3061,14 @@ "members":{ "operatingSystemFamily":{ "shape":"String", - "documentation":"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.
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.
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.
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.
An object that represents the compute environment architecture for Batch jobs on Fargate.
" + "documentation":"An object that represents the compute environment architecture for Batch jobs on Fargate.
" }, "SchedulingPolicyDetail":{ "type":"structure", @@ -3165,7 +3193,7 @@ }, "schedulingPriorityOverride":{ "shape":"Integer", - "documentation":"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.
" + "documentation":"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.
" }, "arrayProperties":{ "shape":"ArrayProperties", @@ -3346,18 +3374,18 @@ "members":{ "hardLimit":{ "shape":"Integer", - "documentation":"The hard limit for the ulimit type.
The hard limit for the ulimit type.
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.
The soft limit for the ulimit type.
The ulimit settings to pass to the container.
This object isn't applicable to jobs that are running on Fargate resources.
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.
The enrollment status of a specific account ID in the organization.
" + "documentation":"The account ID of a member account in the organization.
" }, "includeOrganizationInfo":{ "shape":"PrimitiveBoolean", @@ -863,9 +863,13 @@ "ListEnrollmentStatusesResponse":{ "type":"structure", "members":{ + "includeMemberAccounts":{ + "shape":"Boolean", + "documentation":"The enrollment status of all member accounts in the organization if the account is the management account.
" + }, "items":{ "shape":"AccountEnrollmentStatuses", - "documentation":"The account enrollment statuses.
" + "documentation":"The enrollment status of a specific account ID, including creation and last updated timestamps.
" }, "nextToken":{ "shape":"String", diff --git a/botocore/data/ecs/2014-11-13/service-2.json b/botocore/data/ecs/2014-11-13/service-2.json index d45ef92ba0..9e82e520ba 100644 --- a/botocore/data/ecs/2014-11-13/service-2.json +++ b/botocore/data/ecs/2014-11-13/service-2.json @@ -572,7 +572,7 @@ {"shape":"ClientException"}, {"shape":"InvalidParameterException"} ], - "documentation":"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.
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":{ "name":"PutAccountSettingDefault", @@ -4404,7 +4404,7 @@ "members":{ "name":{ "shape":"SettingName", - "documentation":"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.
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 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 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. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.
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 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 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.
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.
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 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 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. For more information on using IPv6 with tasks launched on Fargate, see Using a VPC in dual-stack mode.
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 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 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.
Any failures associated with the call.
" + "documentation":"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.
" } } }, diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index c7687dd4ec..66628592e4 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/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/botocore/data/iot/2015-05-28/service-2.json b/botocore/data/iot/2015-05-28/service-2.json index 030dc586dc..9a6d1ee3b8 100644 --- a/botocore/data/iot/2015-05-28/service-2.json +++ b/botocore/data/iot/2015-05-28/service-2.json @@ -1714,7 +1714,7 @@ {"shape":"UnauthorizedException"}, {"shape":"ThrottlingException"} ], - "documentation":"Returns a unique endpoint specific to the Amazon Web Services account making the call.
Requires permission to access the DescribeEndpoint action.
" + "documentation":"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":{ "name":"DescribeEventConfigurations", @@ -2382,7 +2382,7 @@ {"shape":"InternalFailureException"}, {"shape":"InvalidRequestException"} ], - "documentation":"Gets a registration code used to register a CA certificate with IoT.
Requires permission to access the GetRegistrationCode action.
" + "documentation":"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":{ "name":"GetStatistics", @@ -7011,6 +7011,10 @@ "tlsConfig":{ "shape":"TlsConfig", "documentation":"An object that specifies the TLS configuration for a domain.
" + }, + "serverCertificateConfig":{ + "shape":"ServerCertificateConfig", + "documentation":"The server certificate configuration.
" } } }, @@ -9486,6 +9490,10 @@ "tlsConfig":{ "shape":"TlsConfig", "documentation":"An object that specifies the TLS configuration for a domain.
" + }, + "serverCertificateConfig":{ + "shape":"ServerCertificateConfig", + "documentation":"The server certificate configuration.
" } } }, @@ -10910,6 +10918,7 @@ }, "documentation":"Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
" }, + "EnableOCSPCheck":{"type":"boolean"}, "EnableTopicRuleRequest":{ "type":"structure", "required":["ruleName"], @@ -17621,6 +17630,16 @@ "max":1, "min":0 }, + "ServerCertificateConfig":{ + "type":"structure", + "members":{ + "enableOCSPCheck":{ + "shape":"EnableOCSPCheck", + "documentation":"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.
" + } + }, + "documentation":"The server certificate configuration.
" + }, "ServerCertificateStatus":{ "type":"string", "enum":[ @@ -19819,6 +19838,10 @@ "tlsConfig":{ "shape":"TlsConfig", "documentation":"An object that specifies the TLS configuration for a domain.
" + }, + "serverCertificateConfig":{ + "shape":"ServerCertificateConfig", + "documentation":"The server certificate configuration.
" } } }, diff --git a/botocore/data/pricing/2017-10-15/endpoint-rule-set-1.json b/botocore/data/pricing/2017-10-15/endpoint-rule-set-1.json index a87f285e6f..309ef25b58 100644 --- a/botocore/data/pricing/2017-10-15/endpoint-rule-set-1.json +++ b/botocore/data/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/botocore/data/pricing/2017-10-15/service-2.json b/botocore/data/pricing/2017-10-15/service-2.json index 61fa4423d6..4af40a45f3 100644 --- a/botocore/data/pricing/2017-10-15/service-2.json +++ b/botocore/data/pricing/2017-10-15/service-2.json @@ -27,6 +27,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"NotFoundException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ], "documentation":"Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.
Returns a list of attribute values. Attributes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the Billing and Cost Management User Guide.
" @@ -60,7 +62,8 @@ {"shape":"InvalidParameterException"}, {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, - {"shape":"InternalErrorException"} + {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"} ], "documentation":"This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.
Returns a list of all products that match the filter criteria.
" @@ -95,6 +99,7 @@ {"shape":"NotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"InternalErrorException"}, + {"shape":"ThrottlingException"}, {"shape":"ExpiredNextTokenException"} ], "documentation":"This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.
An error on the server occurred during the processing of your request. Try again later.
", "exception":true, - "fault":true + "fault":true, + "retryable":{"throttling":false} }, "InvalidNextTokenException":{ "type":"structure", @@ -443,7 +449,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", @@ -487,6 +493,15 @@ }, "String":{"type":"string"}, "SynthesizedJsonPriceListJsonItem":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"You've made too many requests exceeding service quotas.
", + "exception":true, + "retryable":{"throttling":true} + }, "errorMessage":{"type":"string"} }, "documentation":"The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:
Build cost control and scenario planning tools
Reconcile billing data
Forecast future spend for budgeting purposes
Provide cost benefit analysis that compare your internal workloads with Amazon Web Services
Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.
For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.
" diff --git a/docs/source/conf.py b/docs/source/conf.py index e15b70f255..bc30eae68e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -59,7 +59,7 @@ # The short X.Y version. version = '1.34.' # The full version, including alpha/beta/rc tags. -release = '1.34.38' +release = '1.34.39' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.