Documentation
¶
Index ¶
- type AdHocFilteringOption
- type DashboardError
- type DashboardPublishOptions
- type DashboardSourceEntity
- type DashboardSourceTemplate
- type DashboardVersion
- type DataSetReference
- type DateTimeParameter
- type DecimalParameter
- type ExportToCSVOption
- type IntegerParameter
- type Parameters
- type Resource
- type ResourcePermission
- type Sheet
- type SheetControlsOption
- type StringParameter
- type Tag
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdHocFilteringOption ¶
type AdHocFilteringOption struct {
AvailabilityStatus string `json:"AvailabilityStatus,omitempty"`
}
AdHocFilteringOption <p>Ad hoc (one-time) filtering option.</p>
func (*AdHocFilteringOption) MarshalJSON ¶
func (strct *AdHocFilteringOption) MarshalJSON() ([]byte, error)
func (*AdHocFilteringOption) UnmarshalJSON ¶
func (strct *AdHocFilteringOption) UnmarshalJSON(b []byte) error
type DashboardError ¶
type DashboardError struct { // <p>Message.</p> Message string `json:"Message,omitempty"` Type string `json:"Type,omitempty"` }
DashboardError <p>Dashboard error.</p>
func (*DashboardError) MarshalJSON ¶
func (strct *DashboardError) MarshalJSON() ([]byte, error)
func (*DashboardError) UnmarshalJSON ¶
func (strct *DashboardError) UnmarshalJSON(b []byte) error
type DashboardPublishOptions ¶
type DashboardPublishOptions struct { AdHocFilteringOption *AdHocFilteringOption `json:"AdHocFilteringOption,omitempty"` ExportToCSVOption *ExportToCSVOption `json:"ExportToCSVOption,omitempty"` SheetControlsOption *SheetControlsOption `json:"SheetControlsOption,omitempty"` }
DashboardPublishOptions <p>Dashboard publish options.</p>
func (*DashboardPublishOptions) MarshalJSON ¶
func (strct *DashboardPublishOptions) MarshalJSON() ([]byte, error)
func (*DashboardPublishOptions) UnmarshalJSON ¶
func (strct *DashboardPublishOptions) UnmarshalJSON(b []byte) error
type DashboardSourceEntity ¶
type DashboardSourceEntity struct {
SourceTemplate *DashboardSourceTemplate `json:"SourceTemplate,omitempty"`
}
DashboardSourceEntity <p>Dashboard source entity.</p>
func (*DashboardSourceEntity) MarshalJSON ¶
func (strct *DashboardSourceEntity) MarshalJSON() ([]byte, error)
func (*DashboardSourceEntity) UnmarshalJSON ¶
func (strct *DashboardSourceEntity) UnmarshalJSON(b []byte) error
type DashboardSourceTemplate ¶
type DashboardSourceTemplate struct { // <p>The Amazon Resource Name (ARN) of the resource.</p> Arn string `json:"Arn"` // <p>Dataset references.</p> DataSetReferences []*DataSetReference `json:"DataSetReferences"` }
DashboardSourceTemplate <p>Dashboard source template.</p>
func (*DashboardSourceTemplate) MarshalJSON ¶
func (strct *DashboardSourceTemplate) MarshalJSON() ([]byte, error)
func (*DashboardSourceTemplate) UnmarshalJSON ¶
func (strct *DashboardSourceTemplate) UnmarshalJSON(b []byte) error
type DashboardVersion ¶
type DashboardVersion struct { // <p>The Amazon Resource Name (ARN) of the resource.</p> Arn string `json:"Arn,omitempty"` // <p>The time that this dashboard version was created.</p> CreatedTime string `json:"CreatedTime,omitempty"` // <p>The Amazon Resource Numbers (ARNs) for the datasets that are associated with this // version of the dashboard.</p> DataSetArns []string `json:"DataSetArns,omitempty"` // <p>Description.</p> Description string `json:"Description,omitempty"` // <p>Errors associated with this dashboard version.</p> Errors []*DashboardError `json:"Errors,omitempty"` // <p>A list of the associated sheets with the unique identifier and name of each sheet.</p> Sheets []*Sheet `json:"Sheets,omitempty"` // <p>Source entity ARN.</p> SourceEntityArn string `json:"SourceEntityArn,omitempty"` Status string `json:"Status,omitempty"` // <p>The ARN of the theme associated with a version of the dashboard.</p> ThemeArn string `json:"ThemeArn,omitempty"` // <p>Version number for this version of the dashboard.</p> VersionNumber float64 `json:"VersionNumber,omitempty"` }
DashboardVersion <p>Dashboard version.</p>
func (*DashboardVersion) MarshalJSON ¶
func (strct *DashboardVersion) MarshalJSON() ([]byte, error)
func (*DashboardVersion) UnmarshalJSON ¶
func (strct *DashboardVersion) UnmarshalJSON(b []byte) error
type DataSetReference ¶
type DataSetReference struct { // <p>Dataset Amazon Resource Name (ARN).</p> DataSetArn string `json:"DataSetArn"` // <p>Dataset placeholder.</p> DataSetPlaceholder string `json:"DataSetPlaceholder"` }
DataSetReference <p>Dataset reference.</p>
func (*DataSetReference) MarshalJSON ¶
func (strct *DataSetReference) MarshalJSON() ([]byte, error)
func (*DataSetReference) UnmarshalJSON ¶
func (strct *DataSetReference) UnmarshalJSON(b []byte) error
type DateTimeParameter ¶
type DateTimeParameter struct { // <p>A display name for the date-time parameter.</p> Name string `json:"Name"` // <p>The values for the date-time parameter.</p> Values []string `json:"Values"` }
DateTimeParameter <p>A date-time parameter.</p>
func (*DateTimeParameter) MarshalJSON ¶
func (strct *DateTimeParameter) MarshalJSON() ([]byte, error)
func (*DateTimeParameter) UnmarshalJSON ¶
func (strct *DateTimeParameter) UnmarshalJSON(b []byte) error
type DecimalParameter ¶
type DecimalParameter struct { // <p>A display name for the decimal parameter.</p> Name string `json:"Name"` // <p>The values for the decimal parameter.</p> Values []float64 `json:"Values"` }
DecimalParameter <p>A decimal parameter.</p>
func (*DecimalParameter) MarshalJSON ¶
func (strct *DecimalParameter) MarshalJSON() ([]byte, error)
func (*DecimalParameter) UnmarshalJSON ¶
func (strct *DecimalParameter) UnmarshalJSON(b []byte) error
type ExportToCSVOption ¶
type ExportToCSVOption struct {
AvailabilityStatus string `json:"AvailabilityStatus,omitempty"`
}
ExportToCSVOption <p>Export to .csv option.</p>
func (*ExportToCSVOption) MarshalJSON ¶
func (strct *ExportToCSVOption) MarshalJSON() ([]byte, error)
func (*ExportToCSVOption) UnmarshalJSON ¶
func (strct *ExportToCSVOption) UnmarshalJSON(b []byte) error
type IntegerParameter ¶
type IntegerParameter struct { // <p>The name of the integer parameter.</p> Name string `json:"Name"` // <p>The values for the integer parameter.</p> Values []float64 `json:"Values"` }
IntegerParameter <p>An integer parameter.</p>
func (*IntegerParameter) MarshalJSON ¶
func (strct *IntegerParameter) MarshalJSON() ([]byte, error)
func (*IntegerParameter) UnmarshalJSON ¶
func (strct *IntegerParameter) UnmarshalJSON(b []byte) error
type Parameters ¶
type Parameters struct { // <p>Date-time parameters.</p> DateTimeParameters []*DateTimeParameter `json:"DateTimeParameters,omitempty"` // <p>Decimal parameters.</p> DecimalParameters []*DecimalParameter `json:"DecimalParameters,omitempty"` // <p>Integer parameters.</p> IntegerParameters []*IntegerParameter `json:"IntegerParameters,omitempty"` // <p>String parameters.</p> StringParameters []*StringParameter `json:"StringParameters,omitempty"` }
Parameters <p>A list of QuickSight parameters and the list's override values.</p>
func (*Parameters) MarshalJSON ¶
func (strct *Parameters) MarshalJSON() ([]byte, error)
func (*Parameters) UnmarshalJSON ¶
func (strct *Parameters) UnmarshalJSON(b []byte) error
type Resource ¶
type Resource struct { // <p>The Amazon Resource Name (ARN) of the resource.</p> Arn string `json:"Arn,omitempty"` AwsAccountId string `json:"AwsAccountId"` // <p>The time that this dataset was created.</p> CreatedTime string `json:"CreatedTime,omitempty"` DashboardId string `json:"DashboardId"` DashboardPublishOptions *DashboardPublishOptions `json:"DashboardPublishOptions,omitempty"` // <p>The last time that this dataset was published.</p> LastPublishedTime string `json:"LastPublishedTime,omitempty"` // <p>The last time that this dataset was updated.</p> LastUpdatedTime string `json:"LastUpdatedTime,omitempty"` // <p>The display name of the dashboard.</p> Name string `json:"Name,omitempty"` Parameters *Parameters `json:"Parameters,omitempty"` // <p>A structure that contains the permissions of the dashboard. You can use this structure // for granting permissions by providing a list of IAM action information for each // principal ARN. </p> // // <p>To specify no permissions, omit the permissions list.</p> Permissions []*ResourcePermission `json:"Permissions,omitempty"` SourceEntity *DashboardSourceEntity `json:"SourceEntity"` // <p>Contains a map of the key-value pairs for the resource tag or tags assigned to the // dashboard.</p> Tags []*Tag `json:"Tags,omitempty"` // <p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If // you add a value for this field, it overrides the value that is used in the source // entity. The theme ARN must exist in the same AWS account where you create the // dashboard.</p> ThemeArn string `json:"ThemeArn,omitempty"` Version *DashboardVersion `json:"Version,omitempty"` // <p>A description for the first version of the dashboard being created.</p> VersionDescription string `json:"VersionDescription,omitempty"` }
Resource Definition of the AWS::QuickSight::Dashboard Resource Type.
func (*Resource) MarshalJSON ¶
func (*Resource) UnmarshalJSON ¶
type ResourcePermission ¶
type ResourcePermission struct { // <p>The IAM action to grant or revoke permissions on.</p> Actions []string `json:"Actions"` // <p>The Amazon Resource Name (ARN) of the principal. This can be one of the // following:</p> // <ul> // <li> // <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p> // </li> // <li> // <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p> // </li> // <li> // <p>The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight // ARN. Use this option only to share resources (templates) across AWS accounts. // (This is less common.) </p> // </li> // </ul> Principal string `json:"Principal"` }
ResourcePermission <p>Permission for the resource.</p>
func (*ResourcePermission) MarshalJSON ¶
func (strct *ResourcePermission) MarshalJSON() ([]byte, error)
func (*ResourcePermission) UnmarshalJSON ¶
func (strct *ResourcePermission) UnmarshalJSON(b []byte) error
type Sheet ¶
type Sheet struct { // <p>The name of a sheet. This name is displayed on the sheet's tab in the QuickSight // console.</p> Name string `json:"Name,omitempty"` // <p>The unique identifier associated with a sheet.</p> SheetId string `json:"SheetId,omitempty"` }
Sheet <p>A <i>sheet</i>, which is an object that contains a set of visuals that
are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.</p>
func (*Sheet) MarshalJSON ¶
func (*Sheet) UnmarshalJSON ¶
type SheetControlsOption ¶
type SheetControlsOption struct {
VisibilityState string `json:"VisibilityState,omitempty"`
}
SheetControlsOption <p>Sheet controls option.</p>
func (*SheetControlsOption) MarshalJSON ¶
func (strct *SheetControlsOption) MarshalJSON() ([]byte, error)
func (*SheetControlsOption) UnmarshalJSON ¶
func (strct *SheetControlsOption) UnmarshalJSON(b []byte) error
type StringParameter ¶
type StringParameter struct { // <p>A display name for a string parameter.</p> Name string `json:"Name"` // <p>The values of a string parameter.</p> Values []string `json:"Values"` }
StringParameter <p>A string parameter.</p>
func (*StringParameter) MarshalJSON ¶
func (strct *StringParameter) MarshalJSON() ([]byte, error)
func (*StringParameter) UnmarshalJSON ¶
func (strct *StringParameter) UnmarshalJSON(b []byte) error
type Tag ¶
type Tag struct { // <p>Tag key.</p> Key string `json:"Key"` // <p>Tag value.</p> Value string `json:"Value"` }
Tag <p>The key or keys of the key-value pairs for the resource tag or tags assigned to the
resource.</p>