aws-sdk-finspacedata 1.16.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5e654a37ea706f0ec04b85253d080b22d1ebf7c617c0fcf3fa0eeccd25b57e7
-  data.tar.gz: 41fab6545e8bf4fb34b040966f715701889000e472c3f63d1c8983a1bb491729
+  metadata.gz: dcbebb6db6faba8e5da5ffe0b4d13289ce68d505e48ce3fcc3b50dc9c06bdfca
+  data.tar.gz: aa0365c9ee24b059a3151532778f3fcfe4a133ea6e74faeb5e7696c9bddbddb2
 SHA512:
-  metadata.gz: 0a4b20e8a37785f0cc7830e0189428d7e49abef40a4ebb9093cf6e350df04b22a4dbfdfcc3df15cf6142187276fb74e8353dc59f2eb38418aa4629a0c61c0840
-  data.tar.gz: 807943759b455a92cdac063fc281e3ef0453f1d1df955fe389fbb913b10b0d89d186d6dffaf1f939c8e9f53b617064cd167b5bb45334ca75c681bab7c7a5f7a0
+  metadata.gz: '01188ba7914670643dad9d50f01d92c1f0b4ef6470239b913f04eeab1670be8b078e7a7a23f4d6dd801f0848be437b80c470ca8a0f9f3743ba7cd6a887b971a9'
+  data.tar.gz: 7cc3a23d78adc5b4ffd86607d558429a0d38f57ce95a66aa916a5a1fcd65d18bd35c3d1267751638031f6b3d47feed7c9270871bdaac3087abd9881c4a958fc1

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.17.0 (2022-06-28)
+------------------
+
+* Feature - Release new API GetExternalDataViewAccessDetails
+
 1.16.0 (2022-06-15)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.16.0
+1.17.0

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

@@ -667,13 +667,20 @@ module Aws::FinSpaceData
     #   The option to indicate FinSpace application permissions that are
     #   granted to a specific group.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows users
+    #     to grant themselves or others access to any functionality in the
+    #     application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -1143,6 +1150,50 @@ module Aws::FinSpaceData
       req.send_request(options)
     end
 
+    # Returns the credentials to access the external Dataview from an S3
+    # location. To call this API:
+    #
+    # * You must retrieve the programmatic credentials.
+    #
+    # * You must be a member of a FinSpace user group, where the dataset
+    #   that you want to access has `Read Dataset Data` permissions.
+    #
+    # @option params [required, String] :data_view_id
+    #   The unique identifier for the Dataview that you want to access.
+    #
+    # @option params [required, String] :dataset_id
+    #   The unique identifier for the Dataset.
+    #
+    # @return [Types::GetExternalDataViewAccessDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetExternalDataViewAccessDetailsResponse#credentials #credentials} => Types::AwsCredentials
+    #   * {Types::GetExternalDataViewAccessDetailsResponse#s3_location #s3_location} => Types::S3Location
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_external_data_view_access_details({
+    #     data_view_id: "DataViewId", # required
+    #     dataset_id: "DatasetId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.credentials.access_key_id #=> String
+    #   resp.credentials.secret_access_key #=> String
+    #   resp.credentials.session_token #=> String
+    #   resp.credentials.expiration #=> Integer
+    #   resp.s3_location.bucket #=> String
+    #   resp.s3_location.key #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetails AWS API Documentation
+    #
+    # @overload get_external_data_view_access_details(params = {})
+    # @param [Hash] params ({})
+    def get_external_data_view_access_details(params = {}, options = {})
+      req = build_request(:get_external_data_view_access_details, params)
+      req.send_request(options)
+    end
+
     # Retrieves the details of a specific permission group.
     #
     # @option params [required, String] :permission_group_id
@@ -1887,13 +1938,20 @@ module Aws::FinSpaceData
     #   The permissions that are granted to a specific group for accessing the
     #   FinSpace application.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows users
+    #     to grant themselves or others access to any functionality in the
+    #     application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -2022,7 +2080,7 @@ module Aws::FinSpaceData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-finspacedata'
-      context[:gem_version] = '1.16.0'
+      context[:gem_version] = '1.17.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -14,12 +14,14 @@ module Aws::FinSpaceData
     include Seahorse::Model
 
     AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
+    AccessKeyId = Shapes::StringShape.new(name: 'AccessKeyId')
     AliasString = Shapes::StringShape.new(name: 'AliasString')
     ApiAccess = Shapes::StringShape.new(name: 'ApiAccess')
     ApplicationPermission = Shapes::StringShape.new(name: 'ApplicationPermission')
     ApplicationPermissionList = Shapes::ListShape.new(name: 'ApplicationPermissionList')
     AssociateUserToPermissionGroupRequest = Shapes::StructureShape.new(name: 'AssociateUserToPermissionGroupRequest')
     AssociateUserToPermissionGroupResponse = Shapes::StructureShape.new(name: 'AssociateUserToPermissionGroupResponse')
+    AwsCredentials = Shapes::StructureShape.new(name: 'AwsCredentials')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     ChangeType = Shapes::StringShape.new(name: 'ChangeType')
     ChangesetArn = Shapes::StringShape.new(name: 'ChangesetArn')
@@ -85,6 +87,8 @@ module Aws::FinSpaceData
     GetDataViewResponse = Shapes::StructureShape.new(name: 'GetDataViewResponse')
     GetDatasetRequest = Shapes::StructureShape.new(name: 'GetDatasetRequest')
     GetDatasetResponse = Shapes::StructureShape.new(name: 'GetDatasetResponse')
+    GetExternalDataViewAccessDetailsRequest = Shapes::StructureShape.new(name: 'GetExternalDataViewAccessDetailsRequest')
+    GetExternalDataViewAccessDetailsResponse = Shapes::StructureShape.new(name: 'GetExternalDataViewAccessDetailsResponse')
     GetPermissionGroupRequest = Shapes::StructureShape.new(name: 'GetPermissionGroupRequest')
     GetPermissionGroupResponse = Shapes::StructureShape.new(name: 'GetPermissionGroupResponse')
     GetProgrammaticAccessCredentialsRequest = Shapes::StructureShape.new(name: 'GetProgrammaticAccessCredentialsRequest')
@@ -133,10 +137,15 @@ module Aws::FinSpaceData
     ResourcePermissionsList = Shapes::ListShape.new(name: 'ResourcePermissionsList')
     ResultLimit = Shapes::IntegerShape.new(name: 'ResultLimit')
     RoleArn = Shapes::StringShape.new(name: 'RoleArn')
+    S3BucketName = Shapes::StringShape.new(name: 'S3BucketName')
     S3DestinationFormatOptions = Shapes::MapShape.new(name: 'S3DestinationFormatOptions')
+    S3Key = Shapes::StringShape.new(name: 'S3Key')
+    S3Location = Shapes::StructureShape.new(name: 'S3Location')
     SchemaDefinition = Shapes::StructureShape.new(name: 'SchemaDefinition')
     SchemaUnion = Shapes::StructureShape.new(name: 'SchemaUnion')
+    SecretAccessKey = Shapes::StringShape.new(name: 'SecretAccessKey')
     SessionDuration = Shapes::IntegerShape.new(name: 'SessionDuration')
+    SessionToken = Shapes::StringShape.new(name: 'SessionToken')
     SortColumnList = Shapes::ListShape.new(name: 'SortColumnList')
     SourceParams = Shapes::MapShape.new(name: 'SourceParams')
     StatusCode = Shapes::IntegerShape.new(name: 'StatusCode')
@@ -182,6 +191,12 @@ module Aws::FinSpaceData
     AssociateUserToPermissionGroupResponse.add_member(:status_code, Shapes::ShapeRef.new(shape: StatusCode, location: "statusCode", location_name: "statusCode"))
     AssociateUserToPermissionGroupResponse.struct_class = Types::AssociateUserToPermissionGroupResponse
 
+    AwsCredentials.add_member(:access_key_id, Shapes::ShapeRef.new(shape: AccessKeyId, location_name: "accessKeyId"))
+    AwsCredentials.add_member(:secret_access_key, Shapes::ShapeRef.new(shape: SecretAccessKey, location_name: "secretAccessKey"))
+    AwsCredentials.add_member(:session_token, Shapes::ShapeRef.new(shape: SessionToken, location_name: "sessionToken"))
+    AwsCredentials.add_member(:expiration, Shapes::ShapeRef.new(shape: TimestampEpoch, location_name: "expiration"))
+    AwsCredentials.struct_class = Types::AwsCredentials
+
     ChangesetErrorInfo.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "errorMessage"))
     ChangesetErrorInfo.add_member(:error_category, Shapes::ShapeRef.new(shape: ErrorCategory, location_name: "errorCategory"))
     ChangesetErrorInfo.struct_class = Types::ChangesetErrorInfo
@@ -414,6 +429,14 @@ module Aws::FinSpaceData
     GetDatasetResponse.add_member(:status, Shapes::ShapeRef.new(shape: DatasetStatus, location_name: "status"))
     GetDatasetResponse.struct_class = Types::GetDatasetResponse
 
+    GetExternalDataViewAccessDetailsRequest.add_member(:data_view_id, Shapes::ShapeRef.new(shape: DataViewId, required: true, location: "uri", location_name: "dataviewId"))
+    GetExternalDataViewAccessDetailsRequest.add_member(:dataset_id, Shapes::ShapeRef.new(shape: DatasetId, required: true, location: "uri", location_name: "datasetId"))
+    GetExternalDataViewAccessDetailsRequest.struct_class = Types::GetExternalDataViewAccessDetailsRequest
+
+    GetExternalDataViewAccessDetailsResponse.add_member(:credentials, Shapes::ShapeRef.new(shape: AwsCredentials, location_name: "credentials"))
+    GetExternalDataViewAccessDetailsResponse.add_member(:s3_location, Shapes::ShapeRef.new(shape: S3Location, location_name: "s3Location"))
+    GetExternalDataViewAccessDetailsResponse.struct_class = Types::GetExternalDataViewAccessDetailsResponse
+
     GetPermissionGroupRequest.add_member(:permission_group_id, Shapes::ShapeRef.new(shape: PermissionGroupId, required: true, location: "uri", location_name: "permissionGroupId"))
     GetPermissionGroupRequest.struct_class = Types::GetPermissionGroupRequest
 
@@ -564,6 +587,10 @@ module Aws::FinSpaceData
     S3DestinationFormatOptions.key = Shapes::ShapeRef.new(shape: StringMapKey)
     S3DestinationFormatOptions.value = Shapes::ShapeRef.new(shape: StringMapValue)
 
+    S3Location.add_member(:bucket, Shapes::ShapeRef.new(shape: S3BucketName, required: true, location_name: "bucket"))
+    S3Location.add_member(:key, Shapes::ShapeRef.new(shape: S3Key, required: true, location_name: "key"))
+    S3Location.struct_class = Types::S3Location
+
     SchemaDefinition.add_member(:columns, Shapes::ShapeRef.new(shape: ColumnList, location_name: "columns"))
     SchemaDefinition.add_member(:primary_key_columns, Shapes::ShapeRef.new(shape: ColumnNameList, location_name: "primaryKeyColumns"))
     SchemaDefinition.struct_class = Types::SchemaDefinition
@@ -876,6 +903,19 @@ module Aws::FinSpaceData
         o.errors << Shapes::ShapeRef.new(shape: ConflictException)
       end)
 
+      api.add_operation(:get_external_data_view_access_details, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetExternalDataViewAccessDetails"
+        o.http_method = "POST"
+        o.http_request_uri = "/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details"
+        o.input = Shapes::ShapeRef.new(shape: GetExternalDataViewAccessDetailsRequest)
+        o.output = Shapes::ShapeRef.new(shape: GetExternalDataViewAccessDetailsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
+      end)
+
       api.add_operation(:get_permission_group, Seahorse::Model::Operation.new.tap do |o|
         o.name = "GetPermissionGroup"
         o.http_method = "GET"

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

@@ -69,6 +69,36 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # The credentials required to access the external Dataview from the S3
+    # location.
+    #
+    # @!attribute [rw] access_key_id
+    #   The unique identifier for the security credentials.
+    #   @return [String]
+    #
+    # @!attribute [rw] secret_access_key
+    #   The secret access key that can be used to sign requests.
+    #   @return [String]
+    #
+    # @!attribute [rw] session_token
+    #   The token that users must pass to use the credentials.
+    #   @return [String]
+    #
+    # @!attribute [rw] expiration
+    #   The Epoch time when the current credentials expire.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AwsCredentials AWS API Documentation
+    #
+    class AwsCredentials < Struct.new(
+      :access_key_id,
+      :secret_access_key,
+      :session_token,
+      :expiration)
+      SENSITIVE = [:secret_access_key, :session_token]
+      include Aws::Structure
+    end
+
     # The structure with error messages.
     #
     # @!attribute [rw] error_message
@@ -631,13 +661,20 @@ module Aws::FinSpaceData
     #   The option to indicate FinSpace application permissions that are
     #   granted to a specific group.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows
+    #     users to grant themselves or others access to any functionality in
+    #     the application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -1625,6 +1662,49 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetExternalDataViewAccessDetailsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         data_view_id: "DataViewId", # required
+    #         dataset_id: "DatasetId", # required
+    #       }
+    #
+    # @!attribute [rw] data_view_id
+    #   The unique identifier for the Dataview that you want to access.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_id
+    #   The unique identifier for the Dataset.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetailsRequest AWS API Documentation
+    #
+    class GetExternalDataViewAccessDetailsRequest < Struct.new(
+      :data_view_id,
+      :dataset_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] credentials
+    #   The credentials required to access the external Dataview from the S3
+    #   location.
+    #   @return [Types::AwsCredentials]
+    #
+    # @!attribute [rw] s3_location
+    #   The location where the external Dataview is stored.
+    #   @return [Types::S3Location]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetailsResponse AWS API Documentation
+    #
+    class GetExternalDataViewAccessDetailsResponse < Struct.new(
+      :credentials,
+      :s3_location)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass GetPermissionGroupRequest
     #   data as a hash:
     #
@@ -2250,13 +2330,20 @@ module Aws::FinSpaceData
     #   Indicates the permissions that are granted to a specific group for
     #   accessing the FinSpace application.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows
+    #     users to grant themselves or others access to any functionality in
+    #     the application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -2489,6 +2576,26 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # The location of an external Dataview in an S3 bucket.
+    #
+    # @!attribute [rw] bucket
+    #   The name of the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] key
+    #   The path of the folder, within the S3 bucket that contains the
+    #   Dataset.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/S3Location AWS API Documentation
+    #
+    class S3Location < Struct.new(
+      :bucket,
+      :key)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Definition for a schema on a tabular Dataset.
     #
     # @note When making an API call, you may pass SchemaDefinition
@@ -2796,13 +2903,20 @@ module Aws::FinSpaceData
     #   The permissions that are granted to a specific group for accessing
     #   the FinSpace application.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows
+    #     users to grant themselves or others access to any functionality in
+    #     the application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #

data/lib/aws-sdk-finspacedata.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-finspacedata/customizations'
 # @!group service
 module Aws::FinSpaceData
 
-  GEM_VERSION = '1.16.0'
+  GEM_VERSION = '1.17.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-finspacedata
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core