AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::QuickSight::Types::CreateFolderRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb

Overview

Note:

When making an API call, you may pass CreateFolderRequest data as a hash:

{
  aws_account_id: "AwsAccountId", # required
  folder_id: "RestrictiveResourceId", # required
  name: "FolderName",
  folder_type: "SHARED", # accepts SHARED
  parent_folder_arn: "Arn",
  permissions: [
    {
      principal: "Principal", # required
      actions: ["String"], # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The AWS Account ID.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#folder_idString

The folder ID.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#folder_typeString

The type of folder. By default, folderType is SHARED.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the folder.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#parent_folder_arnString

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#permissionsArray<Types::ResourcePermission>

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Returns:



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Tags for the folder.

Returns:



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 2132

class CreateFolderRequest < Struct.new(
  :aws_account_id,
  :folder_id,
  :name,
  :folder_type,
  :parent_folder_arn,
  :permissions,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end