awscc.quicksight_dashboard¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - quicksight:DescribeDashboard, quicksight:DeleteDashboard
update¶
Parent base class for filters and actions.
definitions:
AdHocFilteringOption:
additionalProperties: false
description: <p>Ad hoc (one-time) filtering option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
DashboardBehavior:
enum:
- ENABLED
- DISABLED
type: string
DashboardError:
additionalProperties: false
description: <p>Dashboard error.</p>
properties:
Message:
description: <p>Message.</p>
pattern: .*\S.*
type: string
Type:
enum:
- ACCESS_DENIED
- SOURCE_NOT_FOUND
- DATA_SET_NOT_FOUND
- INTERNAL_FAILURE
- PARAMETER_VALUE_INCOMPATIBLE
- PARAMETER_TYPE_INVALID
- PARAMETER_NOT_FOUND
- COLUMN_TYPE_MISMATCH
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- COLUMN_REPLACEMENT_MISSING
type: string
type: object
DashboardErrorType:
enum:
- ACCESS_DENIED
- SOURCE_NOT_FOUND
- DATA_SET_NOT_FOUND
- INTERNAL_FAILURE
- PARAMETER_VALUE_INCOMPATIBLE
- PARAMETER_TYPE_INVALID
- PARAMETER_NOT_FOUND
- COLUMN_TYPE_MISMATCH
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- COLUMN_REPLACEMENT_MISSING
type: string
DashboardPublishOptions:
additionalProperties: false
description: <p>Dashboard publish options.</p>
properties:
AdHocFilteringOption:
additionalProperties: false
description: <p>Ad hoc (one-time) filtering option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
ExportToCSVOption:
additionalProperties: false
description: <p>Export to .csv option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
SheetControlsOption:
additionalProperties: false
description: <p>Sheet controls option.</p>
properties:
VisibilityState:
enum:
- EXPANDED
- COLLAPSED
type: string
type: object
type: object
DashboardSourceEntity:
additionalProperties: false
description: <p>Dashboard source entity.</p>
properties:
SourceTemplate:
additionalProperties: false
description: <p>Dashboard source template.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the resource.</p>
type: string
DataSetReferences:
description: <p>Dataset references.</p>
items:
additionalProperties: false
description: <p>Dataset reference.</p>
properties:
DataSetArn:
description: <p>Dataset Amazon Resource Name (ARN).</p>
type: string
DataSetPlaceholder:
description: <p>Dataset placeholder.</p>
pattern: .*\S.*
type: string
required:
- DataSetArn
- DataSetPlaceholder
type: object
minItems: 1
type: array
required:
- Arn
- DataSetReferences
type: object
type: object
DashboardSourceTemplate:
additionalProperties: false
description: <p>Dashboard source template.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the resource.</p>
type: string
DataSetReferences:
description: <p>Dataset references.</p>
items:
additionalProperties: false
description: <p>Dataset reference.</p>
properties:
DataSetArn:
description: <p>Dataset Amazon Resource Name (ARN).</p>
type: string
DataSetPlaceholder:
description: <p>Dataset placeholder.</p>
pattern: .*\S.*
type: string
required:
- DataSetArn
- DataSetPlaceholder
type: object
minItems: 1
type: array
required:
- Arn
- DataSetReferences
type: object
DashboardUIState:
enum:
- EXPANDED
- COLLAPSED
type: string
DashboardVersion:
additionalProperties: false
description: <p>Dashboard version.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the resource.</p>
type: string
CreatedTime:
description: <p>The time that this dashboard version was created.</p>
format: string
type: string
DataSetArns:
description: "<p>The Amazon Resource Numbers (ARNs) for the datasets that\
\ are associated with this\n version of the dashboard.</p>"
items:
type: string
maxItems: 100
minItems: 0
type: array
Description:
description: <p>Description.</p>
maxLength: 512
minLength: 1
type: string
Errors:
description: <p>Errors associated with this dashboard version.</p>
items:
additionalProperties: false
description: <p>Dashboard error.</p>
properties:
Message:
description: <p>Message.</p>
pattern: .*\S.*
type: string
Type:
enum:
- ACCESS_DENIED
- SOURCE_NOT_FOUND
- DATA_SET_NOT_FOUND
- INTERNAL_FAILURE
- PARAMETER_VALUE_INCOMPATIBLE
- PARAMETER_TYPE_INVALID
- PARAMETER_NOT_FOUND
- COLUMN_TYPE_MISMATCH
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- COLUMN_REPLACEMENT_MISSING
type: string
type: object
minItems: 1
type: array
Sheets:
description: <p>A list of the associated sheets with the unique identifier
and name of each sheet.</p>
items:
additionalProperties: false
description: "<p>A <i>sheet</i>, which is an object that contains a set\
\ of visuals that\n are viewed together on one page in the\
\ Amazon QuickSight console. Every analysis and dashboard\n \
\ contains at least one sheet. Each sheet contains at least one visualization\
\ widget, for\n example a chart, pivot table, or narrative\
\ insight. Sheets can be associated with other\n components,\
\ such as controls, filters, and so on.</p>"
properties:
Name:
description: "<p>The name of a sheet. This name is displayed on the\
\ sheet's tab in the QuickSight\n console.</p>"
pattern: .*\S.*
type: string
SheetId:
description: <p>The unique identifier associated with a sheet.</p>
maxLength: 2048
minLength: 1
pattern: '[\w\-]+'
type: string
type: object
maxItems: 20
minItems: 0
type: array
SourceEntityArn:
description: <p>Source entity ARN.</p>
type: string
Status:
enum:
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- DELETED
type: string
ThemeArn:
description: <p>The ARN of the theme associated with a version of the dashboard.</p>
type: string
VersionNumber:
description: <p>Version number for this version of the dashboard.</p>
minimum: 1
type: number
type: object
DataSetReference:
additionalProperties: false
description: <p>Dataset reference.</p>
properties:
DataSetArn:
description: <p>Dataset Amazon Resource Name (ARN).</p>
type: string
DataSetPlaceholder:
description: <p>Dataset placeholder.</p>
pattern: .*\S.*
type: string
required:
- DataSetArn
- DataSetPlaceholder
type: object
DateTimeParameter:
additionalProperties: false
description: <p>A date-time parameter.</p>
properties:
Name:
description: <p>A display name for the date-time parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the date-time parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
DecimalParameter:
additionalProperties: false
description: <p>A decimal parameter.</p>
properties:
Name:
description: <p>A display name for the decimal parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the decimal parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
ExportToCSVOption:
additionalProperties: false
description: <p>Export to .csv option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
IntegerParameter:
additionalProperties: false
description: <p>An integer parameter.</p>
properties:
Name:
description: <p>The name of the integer parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the integer parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
Parameters:
additionalProperties: false
description: <p>A list of QuickSight parameters and the list's override values.</p>
properties:
DateTimeParameters:
description: <p>Date-time parameters.</p>
items:
additionalProperties: false
description: <p>A date-time parameter.</p>
properties:
Name:
description: <p>A display name for the date-time parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the date-time parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
DecimalParameters:
description: <p>Decimal parameters.</p>
items:
additionalProperties: false
description: <p>A decimal parameter.</p>
properties:
Name:
description: <p>A display name for the decimal parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the decimal parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
IntegerParameters:
description: <p>Integer parameters.</p>
items:
additionalProperties: false
description: <p>An integer parameter.</p>
properties:
Name:
description: <p>The name of the integer parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the integer parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
StringParameters:
description: <p>String parameters.</p>
items:
additionalProperties: false
description: <p>A string parameter.</p>
properties:
Name:
description: <p>A display name for a string parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values of a string parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
type: object
ResourcePermission:
additionalProperties: false
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n <li>\n\
\ <p>The ARN of an Amazon QuickSight user or group associated\
\ with a data source or dataset. (This is common.)</p>\n </li>\n\
\ <li>\n <p>The ARN of an Amazon QuickSight user,\
\ group, or namespace associated with an analysis, dashboard, template,\
\ or theme. (This is common.)</p>\n </li>\n <li>\n\
\ <p>The ARN of an AWS account root: This is an IAM ARN rather\
\ than a QuickSight\n ARN. Use this option only to share\
\ resources (templates) across AWS accounts.\n (This\
\ is less common.) </p>\n </li>\n </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
ResourceStatus:
enum:
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- DELETED
type: string
Sheet:
additionalProperties: false
description: "<p>A <i>sheet</i>, which is an object that contains a set of visuals\
\ that\n are viewed together on one page in the Amazon QuickSight\
\ console. Every analysis and dashboard\n contains at least one sheet.\
\ Each sheet contains at least one visualization widget, for\n example\
\ a chart, pivot table, or narrative insight. Sheets can be associated with\
\ other\n components, such as controls, filters, and so on.</p>"
properties:
Name:
description: "<p>The name of a sheet. This name is displayed on the sheet's\
\ tab in the QuickSight\n console.</p>"
pattern: .*\S.*
type: string
SheetId:
description: <p>The unique identifier associated with a sheet.</p>
maxLength: 2048
minLength: 1
pattern: '[\w\-]+'
type: string
type: object
SheetControlsOption:
additionalProperties: false
description: <p>Sheet controls option.</p>
properties:
VisibilityState:
enum:
- EXPANDED
- COLLAPSED
type: string
type: object
StringParameter:
additionalProperties: false
description: <p>A string parameter.</p>
properties:
Name:
description: <p>A display name for a string parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values of a string parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
Tag:
additionalProperties: false
description: "<p>The key or keys of the key-value pairs for the resource tag or\
\ tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
properties:
DashboardPublishOptions:
additionalProperties: false
description: <p>Dashboard publish options.</p>
properties:
AdHocFilteringOption:
additionalProperties: false
description: <p>Ad hoc (one-time) filtering option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
ExportToCSVOption:
additionalProperties: false
description: <p>Export to .csv option.</p>
properties:
AvailabilityStatus:
enum:
- ENABLED
- DISABLED
type: string
type: object
SheetControlsOption:
additionalProperties: false
description: <p>Sheet controls option.</p>
properties:
VisibilityState:
enum:
- EXPANDED
- COLLAPSED
type: string
type: object
type: object
Name:
description: <p>The display name of the dashboard.</p>
maxLength: 2048
minLength: 1
pattern: '[\u0020-\u00FF]+'
type: string
Parameters:
additionalProperties: false
description: <p>A list of QuickSight parameters and the list's override values.</p>
properties:
DateTimeParameters:
description: <p>Date-time parameters.</p>
items:
additionalProperties: false
description: <p>A date-time parameter.</p>
properties:
Name:
description: <p>A display name for the date-time parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the date-time parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
DecimalParameters:
description: <p>Decimal parameters.</p>
items:
additionalProperties: false
description: <p>A decimal parameter.</p>
properties:
Name:
description: <p>A display name for the decimal parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the decimal parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
IntegerParameters:
description: <p>Integer parameters.</p>
items:
additionalProperties: false
description: <p>An integer parameter.</p>
properties:
Name:
description: <p>The name of the integer parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values for the integer parameter.</p>
items:
type: number
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
StringParameters:
description: <p>String parameters.</p>
items:
additionalProperties: false
description: <p>A string parameter.</p>
properties:
Name:
description: <p>A display name for a string parameter.</p>
pattern: .*\S.*
type: string
Values:
description: <p>The values of a string parameter.</p>
items:
type: string
type: array
required:
- Name
- Values
type: object
maxItems: 100
minItems: 0
type: array
type: object
Permissions:
description: "<p>A structure that contains the permissions of the dashboard. You\
\ can use this structure\n for granting permissions by providing\
\ a list of IAM action information for each\n principal ARN. </p>\n\
\n <p>To specify no permissions, omit the permissions list.</p>"
items:
additionalProperties: false
description: <p>Permission for the resource.</p>
properties:
Actions:
description: <p>The IAM action to grant or revoke permissions on.</p>
items:
type: string
maxItems: 16
minItems: 1
type: array
Principal:
description: "<p>The Amazon Resource Name (ARN) of the principal. This can\
\ be one of the\n following:</p>\n <ul>\n \
\ <li>\n <p>The ARN of an Amazon QuickSight user or group\
\ associated with a data source or dataset. (This is common.)</p>\n \
\ </li>\n <li>\n <p>The ARN of an Amazon\
\ QuickSight user, group, or namespace associated with an analysis, dashboard,\
\ template, or theme. (This is common.)</p>\n </li>\n \
\ <li>\n <p>The ARN of an AWS account root: This\
\ is an IAM ARN rather than a QuickSight\n ARN. Use\
\ this option only to share resources (templates) across AWS accounts.\n\
\ (This is less common.) </p>\n </li>\n\
\ </ul>"
maxLength: 256
minLength: 1
type: string
required:
- Actions
- Principal
type: object
maxItems: 64
minItems: 1
type: array
SourceEntity:
additionalProperties: false
description: <p>Dashboard source entity.</p>
properties:
SourceTemplate:
additionalProperties: false
description: <p>Dashboard source template.</p>
properties:
Arn:
description: <p>The Amazon Resource Name (ARN) of the resource.</p>
type: string
DataSetReferences:
description: <p>Dataset references.</p>
items:
additionalProperties: false
description: <p>Dataset reference.</p>
properties:
DataSetArn:
description: <p>Dataset Amazon Resource Name (ARN).</p>
type: string
DataSetPlaceholder:
description: <p>Dataset placeholder.</p>
pattern: .*\S.*
type: string
required:
- DataSetArn
- DataSetPlaceholder
type: object
minItems: 1
type: array
required:
- Arn
- DataSetReferences
type: object
type: object
Tags:
description: "<p>Contains a map of the key-value pairs for the resource tag or\
\ tags assigned to the\n dashboard.</p>"
items:
additionalProperties: false
description: "<p>The key or keys of the key-value pairs for the resource tag\
\ or tags assigned to the\n resource.</p>"
properties:
Key:
description: <p>Tag key.</p>
maxLength: 128
minLength: 1
type: string
Value:
description: <p>Tag value.</p>
maxLength: 256
minLength: 1
type: string
required:
- Key
- Value
type: object
maxItems: 200
minItems: 1
type: array
ThemeArn:
description: "<p>The Amazon Resource Name (ARN) of the theme that is being used\
\ for this dashboard. If\n you add a value for this field, it overrides\
\ the value that is used in the source\n entity. The theme ARN must\
\ exist in the same AWS account where you create the\n dashboard.</p>"
type: string
VersionDescription:
description: <p>A description for the first version of the dashboard being created.</p>
maxLength: 512
minLength: 1
type: string
type:
enum:
- update
Permissions - quicksight:DescribeDashboard, quicksight:DescribeDashboardPermissions, quicksight:UpdateDashboard, quicksight:UpdateDashboardPermissions, quicksight:UpdateDashboardPublishedVersion, quicksight:DescribeTheme, quicksight:TagResource, quicksight:UntagResource, quicksight:ListTagsForResource