aws-sdk-managedgrafana 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '065564804bad82939e60d25841d8dcb7681583b88fbe9c0d172f7a2697fb87f4'
-  data.tar.gz: 67e119b56e6ac05a0dad82ad9f57e8f9e533a47d756a06a783a34d39545e5505
+  metadata.gz: fc8e6f4657047140c76d7e67e03d5e597c6f198c4eca53f6c836e8540f4e729c
+  data.tar.gz: 4fba88dce5a57ebf73610fbd32076467149489e18f56f9843ea2c1cbf1e88c2e
 SHA512:
-  metadata.gz: 56675e343f4bf925f519e8d517c73b497148830701ff0f9bf4fdad5f046375f2295fef2040213d60f0cfa4e164d4c317e00d03fd47efb32fe5e9b940ac0e421c
-  data.tar.gz: 562b9c7c2d174d7062fccfc71363666c94e3e100cf31d7abeebd926ac3c2a9b0eec3af8cc83bc047ad3970b248be5b4dade547610a58593bd76d58aaf6c8783f
+  metadata.gz: 8bbb7a0dd95cf6e0d5727475f10b7a5867e58b4a74c9ed79147fc58b974c1e62750c4a20ff38b7fb51f2343f04f220a2339473485ce2dd045a01d557bfbd0406
+  data.tar.gz: 819600eb6c12c6325cc3b7b6eecac7f239a65a71d62b1a0baa1766b313cd4468d0ba90e0907f35fcc00b478c7efd040a82d110acd2d93ca40c405132eb416f88

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.8.0 (2022-05-13)
+------------------
+
+* Feature - This release adds APIs for creating and deleting API keys in an Amazon Managed Grafana workspace.
+
 1.7.0 (2022-03-31)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.7.0
+1.8.0

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

@@ -588,6 +588,58 @@ module Aws::ManagedGrafana
       req.send_request(options)
     end
 
+    # 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.
+    #
+    # @option params [required, String] :key_name
+    #   Specifies the name of the key to create. Key names must be unique to
+    #   the workspace.
+    #
+    # @option params [required, String] :key_role
+    #   Specifies the permission level of the key.
+    #
+    #   Valid Values: `VIEWER` \| `EDITOR` \| `ADMIN`
+    #
+    # @option params [required, Integer] :seconds_to_live
+    #   Specifies the time in seconds until the key expires. Keys can be valid
+    #   for up to 30 days.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace in which to create an API key.
+    #
+    # @return [Types::CreateWorkspaceApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::CreateWorkspaceApiKeyResponse#key #key} => String
+    #   * {Types::CreateWorkspaceApiKeyResponse#key_name #key_name} => String
+    #   * {Types::CreateWorkspaceApiKeyResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.create_workspace_api_key({
+    #     key_name: "ApiKeyName", # required
+    #     key_role: "String", # required
+    #     seconds_to_live: 1, # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.key #=> String
+    #   resp.key_name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKey AWS API Documentation
+    #
+    # @overload create_workspace_api_key(params = {})
+    # @param [Hash] params ({})
+    def create_workspace_api_key(params = {}, options = {})
+      req = build_request(:create_workspace_api_key, params)
+      req.send_request(options)
+    end
+
     # Deletes an Amazon Managed Grafana workspace.
     #
     # @option params [required, String] :workspace_id
@@ -643,6 +695,40 @@ module Aws::ManagedGrafana
       req.send_request(options)
     end
 
+    # Deletes an API key for a workspace.
+    #
+    # @option params [required, String] :key_name
+    #   The name of the API key to delete.
+    #
+    # @option params [required, String] :workspace_id
+    #   The ID of the workspace to delete.
+    #
+    # @return [Types::DeleteWorkspaceApiKeyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DeleteWorkspaceApiKeyResponse#key_name #key_name} => String
+    #   * {Types::DeleteWorkspaceApiKeyResponse#workspace_id #workspace_id} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_workspace_api_key({
+    #     key_name: "ApiKeyName", # required
+    #     workspace_id: "WorkspaceId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.key_name #=> String
+    #   resp.workspace_id #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceApiKey AWS API Documentation
+    #
+    # @overload delete_workspace_api_key(params = {})
+    # @param [Hash] params ({})
+    def delete_workspace_api_key(params = {}, options = {})
+      req = build_request(:delete_workspace_api_key, params)
+      req.send_request(options)
+    end
+
     # Displays information about one Amazon Managed Grafana workspace.
     #
     # @option params [required, String] :workspace_id
@@ -856,7 +942,7 @@ module Aws::ManagedGrafana
     #
     #   resp.next_token #=> String
     #   resp.permissions #=> Array
-    #   resp.permissions[0].role #=> String, one of "ADMIN", "EDITOR"
+    #   resp.permissions[0].role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
     #   resp.permissions[0].user.id #=> String
     #   resp.permissions[0].user.type #=> String, one of "SSO_USER", "SSO_GROUP"
     #
@@ -1042,7 +1128,7 @@ module Aws::ManagedGrafana
     #     update_instruction_batch: [ # required
     #       {
     #         action: "ADD", # required, accepts ADD, REVOKE
-    #         role: "ADMIN", # required, accepts ADMIN, EDITOR
+    #         role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
     #         users: [ # required
     #           {
     #             id: "SsoId", # required
@@ -1058,7 +1144,7 @@ module Aws::ManagedGrafana
     #
     #   resp.errors #=> Array
     #   resp.errors[0].caused_by.action #=> String, one of "ADD", "REVOKE"
-    #   resp.errors[0].caused_by.role #=> String, one of "ADMIN", "EDITOR"
+    #   resp.errors[0].caused_by.role #=> String, one of "ADMIN", "EDITOR", "VIEWER"
     #   resp.errors[0].caused_by.users #=> Array
     #   resp.errors[0].caused_by.users[0].id #=> String
     #   resp.errors[0].caused_by.users[0].type #=> String, one of "SSO_USER", "SSO_GROUP"
@@ -1327,7 +1413,7 @@ module Aws::ManagedGrafana
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-managedgrafana'
-      context[:gem_version] = '1.7.0'
+      context[:gem_version] = '1.8.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -17,6 +17,8 @@ module Aws::ManagedGrafana
     AccountAccessType = Shapes::StringShape.new(name: 'AccountAccessType')
     AllowedOrganization = Shapes::StringShape.new(name: 'AllowedOrganization')
     AllowedOrganizations = Shapes::ListShape.new(name: 'AllowedOrganizations')
+    ApiKeyName = Shapes::StringShape.new(name: 'ApiKeyName')
+    ApiKeyToken = Shapes::StringShape.new(name: 'ApiKeyToken')
     AssertionAttribute = Shapes::StringShape.new(name: 'AssertionAttribute')
     AssertionAttributes = Shapes::StructureShape.new(name: 'AssertionAttributes')
     AssociateLicenseRequest = Shapes::StructureShape.new(name: 'AssociateLicenseRequest')
@@ -29,10 +31,15 @@ module Aws::ManagedGrafana
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     ClientToken = Shapes::StringShape.new(name: 'ClientToken')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
+    CreateWorkspaceApiKeyRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceApiKeyRequest')
+    CreateWorkspaceApiKeyRequestSecondsToLiveInteger = Shapes::IntegerShape.new(name: 'CreateWorkspaceApiKeyRequestSecondsToLiveInteger')
+    CreateWorkspaceApiKeyResponse = Shapes::StructureShape.new(name: 'CreateWorkspaceApiKeyResponse')
     CreateWorkspaceRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceRequest')
     CreateWorkspaceResponse = Shapes::StructureShape.new(name: 'CreateWorkspaceResponse')
     DataSourceType = Shapes::StringShape.new(name: 'DataSourceType')
     DataSourceTypesList = Shapes::ListShape.new(name: 'DataSourceTypesList')
+    DeleteWorkspaceApiKeyRequest = Shapes::StructureShape.new(name: 'DeleteWorkspaceApiKeyRequest')
+    DeleteWorkspaceApiKeyResponse = Shapes::StructureShape.new(name: 'DeleteWorkspaceApiKeyResponse')
     DeleteWorkspaceRequest = Shapes::StructureShape.new(name: 'DeleteWorkspaceRequest')
     DeleteWorkspaceResponse = Shapes::StructureShape.new(name: 'DeleteWorkspaceResponse')
     DescribeWorkspaceAuthenticationRequest = Shapes::StructureShape.new(name: 'DescribeWorkspaceAuthenticationRequest')
@@ -156,6 +163,17 @@ module Aws::ManagedGrafana
     ConflictException.add_member(:resource_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "resourceType"))
     ConflictException.struct_class = Types::ConflictException
 
+    CreateWorkspaceApiKeyRequest.add_member(:key_name, Shapes::ShapeRef.new(shape: ApiKeyName, required: true, location_name: "keyName"))
+    CreateWorkspaceApiKeyRequest.add_member(:key_role, Shapes::ShapeRef.new(shape: String, required: true, location_name: "keyRole"))
+    CreateWorkspaceApiKeyRequest.add_member(:seconds_to_live, Shapes::ShapeRef.new(shape: CreateWorkspaceApiKeyRequestSecondsToLiveInteger, required: true, location_name: "secondsToLive"))
+    CreateWorkspaceApiKeyRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
+    CreateWorkspaceApiKeyRequest.struct_class = Types::CreateWorkspaceApiKeyRequest
+
+    CreateWorkspaceApiKeyResponse.add_member(:key, Shapes::ShapeRef.new(shape: ApiKeyToken, required: true, location_name: "key"))
+    CreateWorkspaceApiKeyResponse.add_member(:key_name, Shapes::ShapeRef.new(shape: ApiKeyName, required: true, location_name: "keyName"))
+    CreateWorkspaceApiKeyResponse.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId"))
+    CreateWorkspaceApiKeyResponse.struct_class = Types::CreateWorkspaceApiKeyResponse
+
     CreateWorkspaceRequest.add_member(:account_access_type, Shapes::ShapeRef.new(shape: AccountAccessType, required: true, location_name: "accountAccessType"))
     CreateWorkspaceRequest.add_member(:authentication_providers, Shapes::ShapeRef.new(shape: AuthenticationProviders, required: true, location_name: "authenticationProviders"))
     CreateWorkspaceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
@@ -176,6 +194,14 @@ module Aws::ManagedGrafana
 
     DataSourceTypesList.member = Shapes::ShapeRef.new(shape: DataSourceType)
 
+    DeleteWorkspaceApiKeyRequest.add_member(:key_name, Shapes::ShapeRef.new(shape: ApiKeyName, required: true, location: "uri", location_name: "keyName"))
+    DeleteWorkspaceApiKeyRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
+    DeleteWorkspaceApiKeyRequest.struct_class = Types::DeleteWorkspaceApiKeyRequest
+
+    DeleteWorkspaceApiKeyResponse.add_member(:key_name, Shapes::ShapeRef.new(shape: ApiKeyName, required: true, location_name: "keyName"))
+    DeleteWorkspaceApiKeyResponse.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "workspaceId"))
+    DeleteWorkspaceApiKeyResponse.struct_class = Types::DeleteWorkspaceApiKeyResponse
+
     DeleteWorkspaceRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
     DeleteWorkspaceRequest.struct_class = Types::DeleteWorkspaceRequest
 
@@ -447,6 +473,21 @@ module Aws::ManagedGrafana
         o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
       end)
 
+      api.add_operation(:create_workspace_api_key, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "CreateWorkspaceApiKey"
+        o.http_method = "POST"
+        o.http_request_uri = "/workspaces/{workspaceId}/apikeys"
+        o.input = Shapes::ShapeRef.new(shape: CreateWorkspaceApiKeyRequest)
+        o.output = Shapes::ShapeRef.new(shape: CreateWorkspaceApiKeyResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
+      end)
+
       api.add_operation(:delete_workspace, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DeleteWorkspace"
         o.http_method = "DELETE"
@@ -461,6 +502,20 @@ module Aws::ManagedGrafana
         o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
       end)
 
+      api.add_operation(:delete_workspace_api_key, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "DeleteWorkspaceApiKey"
+        o.http_method = "DELETE"
+        o.http_request_uri = "/workspaces/{workspaceId}/apikeys/{keyName}"
+        o.input = Shapes::ShapeRef.new(shape: DeleteWorkspaceApiKeyRequest)
+        o.output = Shapes::ShapeRef.new(shape: DeleteWorkspaceApiKeyResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ConflictException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+      end)
+
       api.add_operation(:describe_workspace, Seahorse::Model::Operation.new.tap do |o|
         o.name = "DescribeWorkspace"
         o.http_method = "GET"

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

@@ -213,6 +213,70 @@ module Aws::ManagedGrafana
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass CreateWorkspaceApiKeyRequest
+    #   data as a hash:
+    #
+    #       {
+    #         key_name: "ApiKeyName", # required
+    #         key_role: "String", # required
+    #         seconds_to_live: 1, # required
+    #         workspace_id: "WorkspaceId", # required
+    #       }
+    #
+    # @!attribute [rw] key_name
+    #   Specifies the name of the key to create. Key names must be unique to
+    #   the workspace.
+    #   @return [String]
+    #
+    # @!attribute [rw] key_role
+    #   Specifies the permission level of the key.
+    #
+    #   Valid Values: `VIEWER` \| `EDITOR` \| `ADMIN`
+    #   @return [String]
+    #
+    # @!attribute [rw] seconds_to_live
+    #   Specifies the time in seconds until the key expires. Keys can be
+    #   valid for up to 30 days.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] workspace_id
+    #   The ID of the workspace in which to create an API key.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKeyRequest AWS API Documentation
+    #
+    class CreateWorkspaceApiKeyRequest < Struct.new(
+      :key_name,
+      :key_role,
+      :seconds_to_live,
+      :workspace_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] key
+    #   The key token that was created. Use this value as a bearer token to
+    #   authenticate HTTP requests to the workspace.
+    #   @return [String]
+    #
+    # @!attribute [rw] key_name
+    #   The name of the key that was created.
+    #   @return [String]
+    #
+    # @!attribute [rw] workspace_id
+    #   The ID of the workspace that the key is valid for.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/CreateWorkspaceApiKeyResponse AWS API Documentation
+    #
+    class CreateWorkspaceApiKeyResponse < Struct.new(
+      :key,
+      :key_name,
+      :workspace_id)
+      SENSITIVE = [:key]
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateWorkspaceRequest
     #   data as a hash:
     #
@@ -377,6 +441,48 @@ module Aws::ManagedGrafana
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteWorkspaceApiKeyRequest
+    #   data as a hash:
+    #
+    #       {
+    #         key_name: "ApiKeyName", # required
+    #         workspace_id: "WorkspaceId", # required
+    #       }
+    #
+    # @!attribute [rw] key_name
+    #   The name of the API key to delete.
+    #   @return [String]
+    #
+    # @!attribute [rw] workspace_id
+    #   The ID of the workspace to delete.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceApiKeyRequest AWS API Documentation
+    #
+    class DeleteWorkspaceApiKeyRequest < Struct.new(
+      :key_name,
+      :workspace_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] key_name
+    #   The name of the API key that was deleted.
+    #   @return [String]
+    #
+    # @!attribute [rw] workspace_id
+    #   The ID of the workspace where the key was deleted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/grafana-2020-08-18/DeleteWorkspaceApiKeyResponse AWS API Documentation
+    #
+    class DeleteWorkspaceApiKeyResponse < Struct.new(
+      :key_name,
+      :workspace_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteWorkspaceRequest
     #   data as a hash:
     #
@@ -1041,7 +1147,7 @@ module Aws::ManagedGrafana
     #
     #       {
     #         action: "ADD", # required, accepts ADD, REVOKE
-    #         role: "ADMIN", # required, accepts ADMIN, EDITOR
+    #         role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
     #         users: [ # required
     #           {
     #             id: "SsoId", # required
@@ -1081,7 +1187,7 @@ module Aws::ManagedGrafana
     #         update_instruction_batch: [ # required
     #           {
     #             action: "ADD", # required, accepts ADD, REVOKE
-    #             role: "ADMIN", # required, accepts ADMIN, EDITOR
+    #             role: "ADMIN", # required, accepts ADMIN, EDITOR, VIEWER
     #             users: [ # required
     #               {
     #                 id: "SsoId", # required

data/lib/aws-sdk-managedgrafana.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-managedgrafana/customizations'
 # @!group service
 module Aws::ManagedGrafana
 
-  GEM_VERSION = '1.7.0'
+  GEM_VERSION = '1.8.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-managedgrafana
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-31 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core