Amazonka.Grafana.CreateWorkspaceApiKey

Creates a Grafana 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 for available APIs and example requests.

Creating a Request

data CreateWorkspaceApiKey

See: newCreateWorkspaceApiKey smart constructor.

Constructors

CreateWorkspaceApiKey'

Fields

• keyName :: Text

  Specifies the name of the key. Keynames must be unique to the workspace.

• keyRole :: Text

  Specifies the permission level of the key.

  Valid values: VIEWER|EDITOR|ADMIN

• secondsToLive :: Natural

  Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

• workspaceId :: Text

  The ID of the workspace to create an API key.

Instances

ToJSON CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

toJSON :: CreateWorkspaceApiKey -> Value

toEncoding :: CreateWorkspaceApiKey -> Encoding

toJSONList :: [CreateWorkspaceApiKey] -> Value

toEncodingList :: [CreateWorkspaceApiKey] -> Encoding

ToHeaders CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

toHeaders :: CreateWorkspaceApiKey -> [Header]

ToPath CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

toPath :: CreateWorkspaceApiKey -> ByteString

ToQuery CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

toQuery :: CreateWorkspaceApiKey -> QueryString

AWSRequest CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Associated Types

type AWSResponse CreateWorkspaceApiKey

Methods

request :: (Service -> Service) -> CreateWorkspaceApiKey -> Request CreateWorkspaceApiKey

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkspaceApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkspaceApiKey)))

Generic CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Associated Types

type Rep CreateWorkspaceApiKey :: Type -> Type

Methods

from :: CreateWorkspaceApiKey -> Rep CreateWorkspaceApiKey x

to :: Rep CreateWorkspaceApiKey x -> CreateWorkspaceApiKey

Read CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

readsPrec :: Int -> ReadS CreateWorkspaceApiKey

readList :: ReadS [CreateWorkspaceApiKey]

readPrec :: ReadPrec CreateWorkspaceApiKey

readListPrec :: ReadPrec [CreateWorkspaceApiKey]

Show CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

showsPrec :: Int -> CreateWorkspaceApiKey -> ShowS

show :: CreateWorkspaceApiKey -> String

showList :: [CreateWorkspaceApiKey] -> ShowS

NFData CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

rnf :: CreateWorkspaceApiKey -> ()

Eq CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

(==) :: CreateWorkspaceApiKey -> CreateWorkspaceApiKey -> Bool

(/=) :: CreateWorkspaceApiKey -> CreateWorkspaceApiKey -> Bool

Hashable CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

hashWithSalt :: Int -> CreateWorkspaceApiKey -> Int

hash :: CreateWorkspaceApiKey -> Int

type AWSResponse CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

type AWSResponse CreateWorkspaceApiKey = CreateWorkspaceApiKeyResponse

type Rep CreateWorkspaceApiKey

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

type Rep CreateWorkspaceApiKey = D1 ('MetaData "CreateWorkspaceApiKey" "Amazonka.Grafana.CreateWorkspaceApiKey" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "CreateWorkspaceApiKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "secondsToLive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateWorkspaceApiKey

Arguments

:: Text

CreateWorkspaceApiKey

-> Text

$sel:keyRole:CreateWorkspaceApiKey'

-> Natural

$sel:secondsToLive:CreateWorkspaceApiKey'

-> Text

CreateWorkspaceApiKey

-> CreateWorkspaceApiKey

Create a value of CreateWorkspaceApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateWorkspaceApiKey, createWorkspaceApiKey_keyName - Specifies the name of the key. Keynames must be unique to the workspace.

$sel:keyRole:CreateWorkspaceApiKey', createWorkspaceApiKey_keyRole - Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

$sel:secondsToLive:CreateWorkspaceApiKey', createWorkspaceApiKey_secondsToLive - Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

CreateWorkspaceApiKey, createWorkspaceApiKey_workspaceId - The ID of the workspace to create an API key.

Request Lenses

createWorkspaceApiKey_keyName :: Lens' CreateWorkspaceApiKey Text

Specifies the name of the key. Keynames must be unique to the workspace.

createWorkspaceApiKey_keyRole :: Lens' CreateWorkspaceApiKey Text

Specifies the permission level of the key.

Valid values: VIEWER|EDITOR|ADMIN

createWorkspaceApiKey_secondsToLive :: Lens' CreateWorkspaceApiKey Natural

Specifies the time in seconds until the key expires. Keys can be valid for up to 30 days.

createWorkspaceApiKey_workspaceId :: Lens' CreateWorkspaceApiKey Text

The ID of the workspace to create an API key.

Destructuring the Response

data CreateWorkspaceApiKeyResponse

See: newCreateWorkspaceApiKeyResponse smart constructor.

Constructors

CreateWorkspaceApiKeyResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• key :: Sensitive Text

  The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

• keyName :: Text

  The name of the key that was created.

• workspaceId :: Text

  The ID of the workspace that the key is valid for.

Instances

Generic CreateWorkspaceApiKeyResponse

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Associated Types

type Rep CreateWorkspaceApiKeyResponse :: Type -> Type

Methods

from :: CreateWorkspaceApiKeyResponse -> Rep CreateWorkspaceApiKeyResponse x

to :: Rep CreateWorkspaceApiKeyResponse x -> CreateWorkspaceApiKeyResponse

Show CreateWorkspaceApiKeyResponse

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

showsPrec :: Int -> CreateWorkspaceApiKeyResponse -> ShowS

show :: CreateWorkspaceApiKeyResponse -> String

showList :: [CreateWorkspaceApiKeyResponse] -> ShowS

NFData CreateWorkspaceApiKeyResponse

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

rnf :: CreateWorkspaceApiKeyResponse -> ()

Eq CreateWorkspaceApiKeyResponse

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

Methods

(==) :: CreateWorkspaceApiKeyResponse -> CreateWorkspaceApiKeyResponse -> Bool

(/=) :: CreateWorkspaceApiKeyResponse -> CreateWorkspaceApiKeyResponse -> Bool

type Rep CreateWorkspaceApiKeyResponse

Defined in Amazonka.Grafana.CreateWorkspaceApiKey

type Rep CreateWorkspaceApiKeyResponse = D1 ('MetaData "CreateWorkspaceApiKeyResponse" "Amazonka.Grafana.CreateWorkspaceApiKey" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "CreateWorkspaceApiKeyResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))) :*: (S1 ('MetaSel ('Just "keyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateWorkspaceApiKeyResponse

Arguments

:: Int

$sel:httpStatus:CreateWorkspaceApiKeyResponse'

-> Text

$sel:key:CreateWorkspaceApiKeyResponse'

-> Text

CreateWorkspaceApiKey

-> Text

CreateWorkspaceApiKey

-> CreateWorkspaceApiKeyResponse

Create a value of CreateWorkspaceApiKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:CreateWorkspaceApiKeyResponse', createWorkspaceApiKeyResponse_httpStatus - The response's http status code.

$sel:key:CreateWorkspaceApiKeyResponse', createWorkspaceApiKeyResponse_key - The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

CreateWorkspaceApiKey, createWorkspaceApiKeyResponse_keyName - The name of the key that was created.

CreateWorkspaceApiKey, createWorkspaceApiKeyResponse_workspaceId - The ID of the workspace that the key is valid for.

Response Lenses

createWorkspaceApiKeyResponse_httpStatus :: Lens' CreateWorkspaceApiKeyResponse Int

The response's http status code.

createWorkspaceApiKeyResponse_key :: Lens' CreateWorkspaceApiKeyResponse Text

The key token. Use this value as a bearer token to authenticate HTTP requests to the workspace.

createWorkspaceApiKeyResponse_keyName :: Lens' CreateWorkspaceApiKeyResponse Text

The name of the key that was created.

createWorkspaceApiKeyResponse_workspaceId :: Lens' CreateWorkspaceApiKeyResponse Text

The ID of the workspace that the key is valid for.