AWS cli documentation change
Summary
Updated CLI version references, reordered fields in scraper structure documentation, added clarifications for IAM roles, cross-account scraping configuration, and failure reasons
Security assessment
The changes add documentation about IAM role requirements (roleArn, sourceRoleArn, targetRoleArn) and cross-account scraping configurations, which are security-related features. However, there is no evidence this addresses a specific security vulnerability.
Diff
diff --git a/cli/latest/reference/amp/describe-scraper.md b/cli/latest/reference/amp/describe-scraper.md index fced72a4e..a6de4248e 100644 --- a//cli/latest/reference/amp/describe-scraper.md +++ b//cli/latest/reference/amp/describe-scraper.md @@ -15 +15 @@ - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) » @@ -202,0 +203,4 @@ scraper -> (structure) +> scraperId -> (string) +> +>> The ID of the scraper. For example, `s-example1-1234-abcd-5678-ef9012abcd34` . +> @@ -207 +211 @@ scraper -> (structure) -> createdAt -> (timestamp) +> roleArn -> (string) @@ -209 +213,3 @@ scraper -> (structure) ->> The date and time that the scraper was created. +>> The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf. +>> +>> For example, `arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example` . @@ -211 +217 @@ scraper -> (structure) -> destination -> (tagged union structure) +> status -> (structure) @@ -213,5 +219 @@ scraper -> (structure) ->> The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. ->> ->> ### Note ->> ->> This is a Tagged Union structure. Only one of the following top level keys can be set: `ampConfiguration`. +>> A structure that contains the current status of the scraper. @@ -219 +221 @@ scraper -> (structure) ->> ampConfiguration -> (structure) +>> statusCode -> (string) @@ -221,5 +223 @@ scraper -> (structure) ->>> The Amazon Managed Service for Prometheus workspace to send metrics to. ->>> ->>> workspaceArn -> (string) ->>> ->>>> ARN of the Amazon Managed Service for Prometheus workspace. +>>> The current status of the scraper. @@ -227 +225 @@ scraper -> (structure) -> lastModifiedAt -> (timestamp) +> createdAt -> (timestamp) @@ -229 +227 @@ scraper -> (structure) ->> The date and time that the scraper was last modified. +>> The date and time that the scraper was created. @@ -231 +229 @@ scraper -> (structure) -> roleArn -> (string) +> lastModifiedAt -> (timestamp) @@ -233,3 +231 @@ scraper -> (structure) ->> The Amazon Resource Name (ARN) of the IAM role that provides permissions for the scraper to discover and collect metrics on your behalf. ->> ->> For example, `arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example` . +>> The date and time that the scraper was last modified. @@ -237 +233 @@ scraper -> (structure) -> roleConfiguration -> (structure) +> tags -> (map) @@ -239 +235 @@ scraper -> (structure) ->> This structure displays information about the IAM roles used for cross-account scraping configuration. +>> (Optional) The list of tag keys and values associated with the scraper. @@ -241 +237 @@ scraper -> (structure) ->> sourceRoleArn -> (string) +>> key -> (string) @@ -243 +239 @@ scraper -> (structure) ->>> The Amazon Resource Name (ARN) of the role used in the source account to enable cross-account scraping. For information about the contents of this policy, see [Cross-account setup](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write) . +>>> The key of the tag. Must not begin with `aws:` . @@ -245 +241 @@ scraper -> (structure) ->> targetRoleArn -> (string) +>> value -> (string) @@ -247 +243,5 @@ scraper -> (structure) ->>> The Amazon Resource Name (ARN) of the role used in the target account to enable cross-account scraping. For information about the contents of this policy, see [Cross-account setup](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write) . +>>> The value of the tag. +> +> statusReason -> (string) +> +>> If there is a failure, the reason for the failure. @@ -261,4 +260,0 @@ scraper -> (structure) -> scraperId -> (string) -> ->> The ID of the scraper. For example, `s-example1-1234-abcd-5678-ef9012abcd34` . -> @@ -297 +293 @@ scraper -> (structure) -> status -> (structure) +> destination -> (tagged union structure) @@ -299 +295 @@ scraper -> (structure) ->> A structure that contains the current status of the scraper. +>> The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. @@ -301 +297 @@ scraper -> (structure) ->> statusCode -> (string) +>> ### Note @@ -303,5 +299,9 @@ scraper -> (structure) ->>> The current status of the scraper. -> -> statusReason -> (string) -> ->> If there is a failure, the reason for the failure. +>> This is a Tagged Union structure. Only one of the following top level keys can be set: `ampConfiguration`. +>> +>> ampConfiguration -> (structure) +>> +>>> The Amazon Managed Service for Prometheus workspace to send metrics to. +>>> +>>> workspaceArn -> (string) +>>> +>>>> ARN of the Amazon Managed Service for Prometheus workspace. @@ -309 +309 @@ scraper -> (structure) -> tags -> (map) +> roleConfiguration -> (structure) @@ -311 +311 @@ scraper -> (structure) ->> (Optional) The list of tag keys and values associated with the scraper. +>> This structure displays information about the IAM roles used for cross-account scraping configuration. @@ -313 +313 @@ scraper -> (structure) ->> key -> (string) +>> sourceRoleArn -> (string) @@ -315 +315 @@ scraper -> (structure) ->>> The key of the tag. Must not begin with `aws:` . +>>> The Amazon Resource Name (ARN) of the role used in the source account to enable cross-account scraping. For information about the contents of this policy, see [Cross-account setup](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write) . @@ -317 +317 @@ scraper -> (structure) ->> value -> (string) +>> targetRoleArn -> (string) @@ -319 +319 @@ scraper -> (structure) ->>> The value of the tag. +>>> The Amazon Resource Name (ARN) of the role used in the target account to enable cross-account scraping. For information about the contents of this policy, see [Cross-account setup](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#cross-account-remote-write) . @@ -331 +331 @@ scraper -> (structure) - * [AWS CLI 2.28.8 Command Reference](../../index.html) » + * [AWS CLI 2.28.11 Command Reference](../../index.html) »