AWS cli documentation change
Summary
Updated AWS CLI version reference, restructured workspace object documentation by reordering fields, modified regex patterns by removing anchors, added new 'kmsKeyId' field for encryption, and removed outdated free trial references.
Security assessment
The change adds documentation for the new 'kmsKeyId' field which enables encryption of workspace data using KMS keys, a security feature. However, there's no evidence this addresses a specific vulnerability. The network access control documentation was restructured but not substantively changed. Regex pattern modifications appear to be syntax adjustments without security implications.
Diff
diff --git a/cli/latest/reference/grafana/describe-workspace.md b/cli/latest/reference/grafana/describe-workspace.md index f449d7ecb..dd7349d2e 100644 --- a//cli/latest/reference/grafana/describe-workspace.md +++ b//cli/latest/reference/grafana/describe-workspace.md @@ -15 +15 @@ - * [AWS CLI 2.33.22 Command Reference](../../index.html) » + * [AWS CLI 2.33.25 Command Reference](../../index.html) » @@ -98 +98 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/grafan -> * pattern: `^g-[0-9a-f]{10}$` +> * pattern: `g-[0-9a-f]{10}` @@ -215,28 +214,0 @@ workspace -> (structure) -> -> authentication -> (structure) [required] -> ->> A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication. ->> ->> providers -> (list) [required] ->> ->>> Specifies whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication. ->>> ->>> (string) ->>> ->>>> Possible values: ->>>> ->>>> * `AWS_SSO` ->>>> * `SAML` ->>>> - ->> ->> samlConfigurationStatus -> (string) ->> ->>> Specifies whether the workplace’s user authentication method is fully configured. ->>> ->>> Possible values: ->>> ->>> * `CONFIGURED` ->>> * `NOT_CONFIGURED` ->>> - @@ -291,27 +262,0 @@ workspace -> (structure) -> -> freeTrialConsumed -> (boolean) -> ->> Specifies whether this workspace has already fully used its free trial for Grafana Enterprise. ->> ->> ### Note ->> ->> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. -> -> freeTrialExpiration -> (timestamp) -> ->> If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends. ->> ->> ### Note ->> ->> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. -> -> grafanaToken -> (string) -> ->> The token that ties this workspace to a Grafana Labs account. For more information, see [Link your account with Grafana Labs](https://docs.aws.amazon.com/grafana/latest/userguide/upgrade-to-Grafana-Enterprise.html#AMG-workspace-register-enterprise) . ->> ->> Constraints: ->> ->> * min: `1` ->> * max: `36` ->> - @@ -336,20 +281 @@ workspace -> (structure) ->> * pattern: `^g-[0-9a-f]{10}$` ->> - -> -> licenseExpiration -> (timestamp) -> ->> If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed. -> -> licenseType -> (string) -> ->> Specifies whether this workspace has a full Grafana Enterprise license. ->> ->> ### Note ->> ->> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. ->> ->> Possible values: ->> ->> * `ENTERPRISE` ->> * `ENTERPRISE_FREE_TRIAL` +>> * pattern: `g-[0-9a-f]{10}` @@ -369 +295 @@ workspace -> (structure) ->> * pattern: `^[a-zA-Z0-9-._~]{1,255}$` +>> * pattern: `[a-zA-Z0-9-._~]{1,255}` @@ -373 +299 @@ workspace -> (structure) -> networkAccessControl -> (structure) +> organizationRoleName -> (string) @@ -375,3 +301 @@ workspace -> (structure) ->> The configuration settings for network access to your workspace. ->> ->> prefixListIds -> (list) [required] +>> The name of the IAM role that is used to access resources through Organizations. @@ -379,14 +303 @@ workspace -> (structure) ->>> An array of prefix list IDs. A prefix list is a list of CIDR ranges of IP addresses. The IP addresses specified are allowed to access your workspace. If the list is not included in the configuration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a prefix list using the Amazon VPC console. ->>> ->>> Prefix list IDs have the format ``pl-_1a2b3c4d_ `` . ->>> ->>> For more information about prefix lists, see [Group CIDR blocks using managed prefix lists](https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) in the _Amazon Virtual Private Cloud User Guide_ . ->>> ->>> (string) ->>> ->>>> Constraints: ->>>> ->>>> * min: `1` ->>>> * max: `100` ->>>> - +>> Constraints: @@ -394 +305,2 @@ workspace -> (structure) ->> vpceIds -> (list) [required] +>> * min: `1` +>> * max: `2048` @@ -396,17 +307,0 @@ workspace -> (structure) ->>> An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a `NetworkAccessConfiguration` is specified then only VPC endpoints specified here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace. ->>> ->>> VPC endpoint IDs have the format ``vpce-_1a2b3c4d_ `` . ->>> ->>> For more information about creating an interface VPC endpoint, see [Interface VPC endpoints](https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints) in the _Amazon Managed Grafana User Guide_ . ->>> ->>> ### Note ->>> ->>> The only VPC endpoints that can be specified here are interface VPC endpoints for Grafana workspaces (using the `com.amazonaws.[region].grafana-workspace` service endpoint). Other VPC endpoints are ignored. ->>> ->>> (string) ->>> ->>>> Constraints: ->>>> ->>>> * min: `1` ->>>> * max: `100` ->>>> @@ -426,11 +320,0 @@ workspace -> (structure) -> -> organizationRoleName -> (string) -> ->> The name of the IAM role that is used to access resources through Organizations. ->> ->> Constraints: ->> ->> * min: `1` ->> * max: `2048` ->> - @@ -485,0 +370,74 @@ workspace -> (structure) +> +> workspaceRoleArn -> (string) +> +>> The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist. +>> +>> Constraints: +>> +>> * min: `1` +>> * max: `2048` +>> + +> +> licenseType -> (string) +> +>> Specifies whether this workspace has a full Grafana Enterprise license. +>> +>> ### Note +>> +>> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. +>> +>> Possible values: +>> +>> * `ENTERPRISE` +>> * `ENTERPRISE_FREE_TRIAL` +>> + +> +> freeTrialConsumed -> (boolean) +> +>> Specifies whether this workspace has already fully used its free trial for Grafana Enterprise. +>> +>> ### Note +>> +>> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. +> +> licenseExpiration -> (timestamp) +> +>> If this workspace has a full Grafana Enterprise license purchased through Amazon Web Services Marketplace, this specifies when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed. +> +> freeTrialExpiration -> (timestamp) +> +>> If this workspace is currently in the free trial period for Grafana Enterprise, this value specifies when that free trial ends. +>> +>> ### Note +>> +>> Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. +> +> authentication -> (structure) [required] +>