aws-sdk-managedgrafana 1.28.0 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bdd4fa674933701a77c180776abf95df58ae4b3880ce47489874bbf16a82924
-  data.tar.gz: 5bf44965fd1b19c520bd0a99b9163a869a7b24ebef41a1dc1aba36d993990bef
+  metadata.gz: 4e61eb56c39cf0c49b86c6e0dfae6ace8cdd8656255c7569cf19203c9e5bedd1
+  data.tar.gz: 42d0589a42fdb8395145ea1e0540bfa597d27fbba9020ad75fc4b43c583f8df9
 SHA512:
-  metadata.gz: cd374c154472b6dfd2332d65416930957af516dbbd2db2daac152eb932efe8d64703f6256fbaff1bc1ac78b5065e56a310cc5c76b38c5947cf06e57c346767b2
-  data.tar.gz: f484f359028a4f370a9d424003a1c2d9fc49635c52751ef9cbd71c3eec31f2132c3824ad17386f3e84a05d72316dc1ffbbb20d0a7fa68eb48b7ed4b70a19e4e1
+  metadata.gz: e75211b05f2fe570fc38b35520c76097aea959d56f44307bdaa70f0642fcc2c8df616925b8aef3931556ddc119cd9a0ca55ddac3e495d724c58f423e7f732f38
+  data.tar.gz: 1033e64d7aace24b5d373bc25176f3aa3bbd3064683aa5e654cb43111caf63419ffb99caf4e7d50efd47160d3d309fb6982e77a59fcb2602e5b0f16ff3894fa6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.29.0 (2024-05-15)
+------------------
+
+* Feature - This release adds new ServiceAccount and ServiceAccountToken APIs.
+
 1.28.0 (2024-05-13)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.28.0
+1.29.0

data/lib/aws-sdk-managedgrafana/client.rb

@@ -413,9 +413,11 @@ module Aws::ManagedGrafana
 
     # @!group API Operations
 
-    # Assigns a Grafana Enterprise license to a workspace. Upgrading to
-    # Grafana Enterprise incurs additional fees. For more information, see
-    # [Upgrade a workspace to Grafana Enterprise][1].
+    # Assigns a Grafana Enterprise license to a workspace. To upgrade, you
+    # must use `ENTERPRISE` for the `licenseType`, and pass in a valid
+    # Grafana Labs token for the `grafanaToken`. Upgrading to Grafana
+    # Enterprise incurs additional fees. For more information, see [Upgrade
+    # a workspace to Grafana Enterprise][1].
     #
     #
     #
@@ -423,8 +425,8 @@ module Aws::ManagedGrafana
     #
     # @option params [String] :grafana_token
     #   A token from Grafana Labs that ties your Amazon Web Services account
-    #   with a Grafana Labs account. For more information, see [Register with
-    #   Grafana Labs][1].
+    #   with a Grafana Labs account. For more information, see [Link your
+    #   account with Grafana Labs][1].
     #
     #
     #
@@ -554,7 +556,7 @@ module Aws::ManagedGrafana
     #
     # @option params [String] :grafana_version
     #   Specifies the version of Grafana to support in the new workspace. If
-    #   not specified, defaults to the latest version (for example, 9.4).
+    #   not specified, defaults to the latest version (for example, 10.4).
     #
     #   To get a list of supported versions, use the `ListVersions` operation.
     #
@@ -735,6 +737,12 @@ module Aws::ManagedGrafana
     # [https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html][1]
     # for available APIs and example requests.
     #
+    # <note markdown="1"> In workspaces compatible with Grafana version 9 or above, use
+    # workspace service accounts instead of API keys. API keys will be
+    # removed in a future release.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html
@@ -746,7 +754,7 @@ module Aws::ManagedGrafana
     # @option params [required, String] :key_role
     #   Specifies the permission level of the key.
     #
-    #   Valid values: `VIEWER`\|`EDITOR`\|`ADMIN`
+    #   Valid values: `ADMIN`\|`EDITOR`\|`VIEWER`
     #
     # @option params [required, Integer] :seconds_to_live
     #   Specifies the time in seconds until the key expires. Keys can be valid
@@ -785,6 +793,143 @@ module Aws::ManagedGrafana
       req.send_request(options)
     end
 
+    # Creates a service account for the workspace. A service account can be
+    # used to call Grafana HTTP APIs, and run automated workloads. After
+    # creating the service account with the correct `GrafanaRole` for your
+    # use case, use `CreateWorkspaceServiceAccountToken` to create a token
+    # that can be used to authenticate and authorize Grafana HTTP API calls.
+    #
+    # You can only create service accounts for workspaces that are
+    # compatible with Grafana version 9 and above.
+    #
+    # <note markdown="1"> For more information about service accounts, see [Service accounts][1]
+    # in the *Amazon Managed Grafana User Guide*.
+    #
+    #  For more information about the Grafana HTTP APIs, see [Using Grafana
+    # HTTP APIs][2] in the *Amazon Managed Grafana User Guide*.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html
+    # [2]: https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html
+    #
+    # @option params [required, String] :grafana_role
+    #   The permission level to use for this service account.
+    #
+    #   <note markdown="1"> For more information about the roles and the permissions each has, see
+    #   [User roles][1] in the *Amazon Managed Grafana User Guide*.
+    #
+    #    </note>
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html
+    #
+    # @option params [required, String] :name
+    #   A name for the service account. The name must be unique within the
+    #   workspace, as it determines the ID associated with the service
+    #   account.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace within which to create the service account.
+    #
+    # @return [Types::CreateWorkspaceServiceAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWorkspaceServiceAccountResponse#grafana_role #grafana_role} => String
+    #   * {Types::CreateWorkspaceServiceAccountResponse#id #id} => String
+    #   * {Types::CreateWorkspaceServiceAccountResponse#name #name} => String
+    #   * {Types::CreateWorkspaceServiceAccountResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_workspace_service_account({
+    #     grafana_role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
+    #     name: "ServiceAccountName", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.grafana_role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
+    #   resp.id #=> String
+    #   resp.name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceServiceAccount AWS API Documentation
+    #
+    # @overload create_workspace_service_account(params = {})
+    # @param [Hash] params ({})
+    def create_workspace_service_account(params = {}, options = {})
+      req = build_request(:create_workspace_service_account, params)
+      req.send_request(options)
+    end
+
+    # Creates a token that can be used to authenticate and authorize Grafana
+    # HTTP API operations for the given [workspace service account][1]. The
+    # service account acts as a user for the API operations, and defines the
+    # permissions that are used by the API.
+    #
+    # When you create the service account token, you will receive a key that
+    # is used when calling Grafana APIs. Do not lose this key, as it will
+    # not be retrievable again.
+    #
+    #  If you do lose the key, you can delete the token and recreate it to
+    # receive a new key. This will disable the initial key.
+    #
+    # Service accounts are only available for workspaces that are compatible
+    # with Grafana version 9 and above.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/grafana/latest/userguide/service-accounts.html
+    #
+    # @option params [required, String] :name
+    #   A name for the token to create.
+    #
+    # @option params [required, Integer] :seconds_to_live
+    #   Sets how long the token will be valid, in seconds. You can set the
+    #   time up to 30 days in the future.
+    #
+    # @option params [required, String] :service_account_id
+    #   The ID of the service account for which to create a token.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace the service account resides within.
+    #
+    # @return [Types::CreateWorkspaceServiceAccountTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWorkspaceServiceAccountTokenResponse#service_account_id #service_account_id} => String
+    #   * {Types::CreateWorkspaceServiceAccountTokenResponse#service_account_token #service_account_token} => Types::ServiceAccountTokenSummaryWithKey
+    #   * {Types::CreateWorkspaceServiceAccountTokenResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_workspace_service_account_token({
+    #     name: "ServiceAccountTokenName", # required
+    #     seconds_to_live: 1, # required
+    #     service_account_id: "String", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.service_account_id #=> String
+    #   resp.service_account_token.id #=> String
+    #   resp.service_account_token.key #=> String
+    #   resp.service_account_token.name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceServiceAccountToken AWS API Documentation
+    #
+    # @overload create_workspace_service_account_token(params = {})
+    # @param [Hash] params ({})
+    def create_workspace_service_account_token(params = {}, options = {})
+      req = build_request(:create_workspace_service_account_token, params)
+      req.send_request(options)
+    end
+
     # Deletes an Amazon Managed Grafana workspace.
     #
     # @option params [required, String] :workspace_id
@@ -851,6 +996,12 @@ module Aws::ManagedGrafana
 
     # Deletes a Grafana API key for the workspace.
     #
+    # <note markdown="1"> In workspaces compatible with Grafana version 9 or above, use
+    # workspace service accounts instead of API keys. API keys will be
+    # removed in a future release.
+    #
+    #  </note>
+    #
     # @option params [required, String] :key_name
     #   The name of the API key to delete.
     #
@@ -883,6 +1034,94 @@ module Aws::ManagedGrafana
       req.send_request(options)
     end
 
+    # Deletes a workspace service account from the workspace.
+    #
+    # This will delete any tokens created for the service account, as well.
+    # If the tokens are currently in use, the will fail to authenticate /
+    # authorize after they are deleted.
+    #
+    # Service accounts are only available for workspaces that are compatible
+    # with Grafana version 9 and above.
+    #
+    # @option params [required, String] :service_account_id
+    #   The ID of the service account to delete.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace where the service account resides.
+    #
+    # @return [Types::DeleteWorkspaceServiceAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DeleteWorkspaceServiceAccountResponse#service_account_id #service_account_id} => String
+    #   * {Types::DeleteWorkspaceServiceAccountResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_workspace_service_account({
+    #     service_account_id: "String", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.service_account_id #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceServiceAccount AWS API Documentation
+    #
+    # @overload delete_workspace_service_account(params = {})
+    # @param [Hash] params ({})
+    def delete_workspace_service_account(params = {}, options = {})
+      req = build_request(:delete_workspace_service_account, params)
+      req.send_request(options)
+    end
+
+    # Deletes a token for the workspace service account.
+    #
+    # This will disable the key associated with the token. If any automation
+    # is currently using the key, it will no longer be authenticated or
+    # authorized to perform actions with the Grafana HTTP APIs.
+    #
+    # Service accounts are only available for workspaces that are compatible
+    # with Grafana version 9 and above.
+    #
+    # @option params [required, String] :service_account_id
+    #   The ID of the service account from which to delete the token.
+    #
+    # @option params [required, String] :token_id
+    #   The ID of the token to delete.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace from which to delete the token.
+    #
+    # @return [Types::DeleteWorkspaceServiceAccountTokenResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DeleteWorkspaceServiceAccountTokenResponse#service_account_id #service_account_id} => String
+    #   * {Types::DeleteWorkspaceServiceAccountTokenResponse#token_id #token_id} => String
+    #   * {Types::DeleteWorkspaceServiceAccountTokenResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_workspace_service_account_token({
+    #     service_account_id: "String", # required
+    #     token_id: "String", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.service_account_id #=> String
+    #   resp.token_id #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceServiceAccountToken AWS API Documentation
+    #
+    # @overload delete_workspace_service_account_token(params = {})
+    # @param [Hash] params ({})
+    def delete_workspace_service_account_token(params = {}, options = {})
+      req = build_request(:delete_workspace_service_account_token, params)
+      req.send_request(options)
+    end
+
     # Displays information about one Amazon Managed Grafana workspace.
     #
     # @option params [required, String] :workspace_id
@@ -1234,6 +1473,120 @@ module Aws::ManagedGrafana
       req.send_request(options)
     end
 
+    # Returns a list of tokens for a workspace service account.
+    #
+    # <note markdown="1"> This does not return the key for each token. You cannot access keys
+    # after they are created. To create a new key, delete the token and
+    # recreate it.
+    #
+    #  </note>
+    #
+    # Service accounts are only available for workspaces that are compatible
+    # with Grafana version 9 and above.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of tokens to include in the results.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of service accounts to return. (You receive
+    #   this token from a previous `ListWorkspaceServiceAccountTokens`
+    #   operation.)
+    #
+    # @option params [required, String] :service_account_id
+    #   The ID of the service account for which to return tokens.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace for which to return tokens.
+    #
+    # @return [Types::ListWorkspaceServiceAccountTokensResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWorkspaceServiceAccountTokensResponse#next_token #next_token} => String
+    #   * {Types::ListWorkspaceServiceAccountTokensResponse#service_account_id #service_account_id} => String
+    #   * {Types::ListWorkspaceServiceAccountTokensResponse#service_account_tokens #service_account_tokens} => Array&lt;Types::ServiceAccountTokenSummary&gt;
+    #   * {Types::ListWorkspaceServiceAccountTokensResponse#workspace_id #workspace_id} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_workspace_service_account_tokens({
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #     service_account_id: "String", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.service_account_id #=> String
+    #   resp.service_account_tokens #=> Array
+    #   resp.service_account_tokens[0].created_at #=> Time
+    #   resp.service_account_tokens[0].expires_at #=> Time
+    #   resp.service_account_tokens[0].id #=> String
+    #   resp.service_account_tokens[0].last_used_at #=> Time
+    #   resp.service_account_tokens[0].name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListWorkspaceServiceAccountTokens AWS API Documentation
+    #
+    # @overload list_workspace_service_account_tokens(params = {})
+    # @param [Hash] params ({})
+    def list_workspace_service_account_tokens(params = {}, options = {})
+      req = build_request(:list_workspace_service_account_tokens, params)
+      req.send_request(options)
+    end
+
+    # Returns a list of service accounts for a workspace.
+    #
+    # Service accounts are only available for workspaces that are compatible
+    # with Grafana version 9 and above.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of service accounts to include in the results.
+    #
+    # @option params [String] :next_token
+    #   The token for the next set of service accounts to return. (You receive
+    #   this token from a previous `ListWorkspaceServiceAccounts` operation.)
+    #
+    # @option params [required, String] :workspace_id
+    #   The workspace for which to list service accounts.
+    #
+    # @return [Types::ListWorkspaceServiceAccountsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListWorkspaceServiceAccountsResponse#next_token #next_token} => String
+    #   * {Types::ListWorkspaceServiceAccountsResponse#service_accounts #service_accounts} => Array&lt;Types::ServiceAccountSummary&gt;
+    #   * {Types::ListWorkspaceServiceAccountsResponse#workspace_id #workspace_id} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_workspace_service_accounts({
+    #     max_results: 1,
+    #     next_token: "PaginationToken",
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.next_token #=> String
+    #   resp.service_accounts #=> Array
+    #   resp.service_accounts[0].grafana_role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
+    #   resp.service_accounts[0].id #=> String
+    #   resp.service_accounts[0].is_disabled #=> String
+    #   resp.service_accounts[0].name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/ListWorkspaceServiceAccounts AWS API Documentation
+    #
+    # @overload list_workspace_service_accounts(params = {})
+    # @param [Hash] params ({})
+    def list_workspace_service_accounts(params = {}, options = {})
+      req = build_request(:list_workspace_service_accounts, params)
+      req.send_request(options)
+    end
+
     # Returns a list of Amazon Managed Grafana workspaces in the account,
     # with some information about each workspace. For more complete
     # information about one workspace, use [DescribeWorkspace][1].
@@ -1771,7 +2124,7 @@ module Aws::ManagedGrafana
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-managedgrafana'
-      context[:gem_version] = '1.28.0'
+      context[:gem_version] = '1.29.0'
       Seahorse::Client::Request.new(handlers, context)
     end