create-workspace-api-key¶
Description¶
Creates an API key for the workspace. This key can be used to authenticate requests sent to the workspace’s HTTP API. See `https\://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html < https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html>`__ for available APIs and example requests.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
create-workspace-api-key
--key-name <value>
--key-role <value>
--seconds-to-live <value>
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--key-name (string)
Specifies the name of the key to create. Key names must be unique to the workspace.
--key-role (string)
Specifies the permission level of the key.
Valid Values:
VIEWER|EDITOR|ADMIN
--seconds-to-live (integer)
Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.
--workspace-id (string)
The ID of the workspace in which to create an API key.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
key -> (string)
The key token that was created. Use this value as a bearer token to authenticate HTTP requests to the workspace.
keyName -> (string)
The name of the key that was created.
workspaceId -> (string)
The ID of the workspace that the key is valid for.