awscc.quicksight_template

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - quicksight:DescribeTemplate, quicksight:DeleteTemplate

update

Parent base class for filters and actions.

definitions:
  ColumnGroupColumnSchema:
    additionalProperties: false
    description: <p>A structure describing the name, data type, and geographic role
      of the columns.</p>
    properties:
      Name:
        description: <p>The name of the column group's column schema.</p>
        type: string
    type: object
  ColumnGroupSchema:
    additionalProperties: false
    description: <p>The column group schema.</p>
    properties:
      ColumnGroupColumnSchemaList:
        description: <p>A structure containing the list of schemas for column group
          columns.</p>
        items:
          additionalProperties: false
          description: <p>A structure describing the name, data type, and geographic
            role of the columns.</p>
          properties:
            Name:
              description: <p>The name of the column group's column schema.</p>
              type: string
          type: object
        maxItems: 500
        minItems: 0
        type: array
      Name:
        description: <p>The name of the column group schema.</p>
        type: string
    type: object
  ColumnSchema:
    additionalProperties: false
    description: <p>The column schema.</p>
    properties:
      DataType:
        description: <p>The data type of the column schema.</p>
        type: string
      GeographicRole:
        description: <p>The geographic role of the column schema.</p>
        type: string
      Name:
        description: <p>The name of the column schema.</p>
        type: string
    type: object
  DataSetConfiguration:
    additionalProperties: false
    description: <p>Dataset configuration.</p>
    properties:
      ColumnGroupSchemaList:
        description: <p>A structure containing the list of column group schemas.</p>
        items:
          additionalProperties: false
          description: <p>The column group schema.</p>
          properties:
            ColumnGroupColumnSchemaList:
              description: <p>A structure containing the list of schemas for column
                group columns.</p>
              items:
                additionalProperties: false
                description: <p>A structure describing the name, data type, and geographic
                  role of the columns.</p>
                properties:
                  Name:
                    description: <p>The name of the column group's column schema.</p>
                    type: string
                type: object
              maxItems: 500
              minItems: 0
              type: array
            Name:
              description: <p>The name of the column group schema.</p>
              type: string
          type: object
        maxItems: 500
        minItems: 0
        type: array
      DataSetSchema:
        additionalProperties: false
        description: <p>Dataset schema.</p>
        properties:
          ColumnSchemaList:
            description: <p>A structure containing the list of column schemas.</p>
            items:
              additionalProperties: false
              description: <p>The column schema.</p>
              properties:
                DataType:
                  description: <p>The data type of the column schema.</p>
                  type: string
                GeographicRole:
                  description: <p>The geographic role of the column schema.</p>
                  type: string
                Name:
                  description: <p>The name of the column schema.</p>
                  type: string
              type: object
            maxItems: 500
            minItems: 0
            type: array
        type: object
      Placeholder:
        description: <p>Placeholder.</p>
        type: string
    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
  DataSetSchema:
    additionalProperties: false
    description: <p>Dataset schema.</p>
    properties:
      ColumnSchemaList:
        description: <p>A structure containing the list of column schemas.</p>
        items:
          additionalProperties: false
          description: <p>The column schema.</p>
          properties:
            DataType:
              description: <p>The data type of the column schema.</p>
              type: string
            GeographicRole:
              description: <p>The geographic role of the column schema.</p>
              type: string
            Name:
              description: <p>The name of the column schema.</p>
              type: string
          type: object
        maxItems: 500
        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
  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
  TemplateError:
    additionalProperties: false
    description: <p>List of errors that occurred when the template version creation
      failed.</p>
    properties:
      Message:
        description: <p>Description of the error type.</p>
        pattern: .*\S.*
        type: string
      Type:
        enum:
        - SOURCE_NOT_FOUND
        - DATA_SET_NOT_FOUND
        - INTERNAL_FAILURE
        - ACCESS_DENIED
        type: string
    type: object
  TemplateErrorType:
    enum:
    - SOURCE_NOT_FOUND
    - DATA_SET_NOT_FOUND
    - INTERNAL_FAILURE
    - ACCESS_DENIED
    type: string
  TemplateSourceAnalysis:
    additionalProperties: false
    description: <p>The source analysis of the template.</p>
    properties:
      Arn:
        description: <p>The Amazon Resource Name (ARN) of the resource.</p>
        type: string
      DataSetReferences:
        description: "<p>A structure containing information about the dataset references\
          \ used as placeholders\n            in the template.</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
  TemplateSourceEntity:
    additionalProperties: false
    description: <p>The source entity of the template.</p>
    properties:
      SourceAnalysis:
        additionalProperties: false
        description: <p>The source analysis of the template.</p>
        properties:
          Arn:
            description: <p>The Amazon Resource Name (ARN) of the resource.</p>
            type: string
          DataSetReferences:
            description: "<p>A structure containing information about the dataset\
              \ references used as placeholders\n            in the template.</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
      SourceTemplate:
        additionalProperties: false
        description: <p>The source template of the template.</p>
        properties:
          Arn:
            description: <p>The Amazon Resource Name (ARN) of the resource.</p>
            type: string
        required:
        - Arn
        type: object
    type: object
  TemplateSourceTemplate:
    additionalProperties: false
    description: <p>The source template of the template.</p>
    properties:
      Arn:
        description: <p>The Amazon Resource Name (ARN) of the resource.</p>
        type: string
    required:
    - Arn
    type: object
  TemplateVersion:
    additionalProperties: false
    description: <p>A version of a template.</p>
    properties:
      CreatedTime:
        description: <p>The time that this template version was created.</p>
        format: string
        type: string
      DataSetConfigurations:
        description: "<p>Schema of the dataset identified by the placeholder. Any\
          \ dashboard created from this\n            template should be bound to new\
          \ datasets matching the same schema described through this\n           \
          \ API operation.</p>"
        items:
          additionalProperties: false
          description: <p>Dataset configuration.</p>
          properties:
            ColumnGroupSchemaList:
              description: <p>A structure containing the list of column group schemas.</p>
              items:
                additionalProperties: false
                description: <p>The column group schema.</p>
                properties:
                  ColumnGroupColumnSchemaList:
                    description: <p>A structure containing the list of schemas for
                      column group columns.</p>
                    items:
                      additionalProperties: false
                      description: <p>A structure describing the name, data type,
                        and geographic role of the columns.</p>
                      properties:
                        Name:
                          description: <p>The name of the column group's column schema.</p>
                          type: string
                      type: object
                    maxItems: 500
                    minItems: 0
                    type: array
                  Name:
                    description: <p>The name of the column group schema.</p>
                    type: string
                type: object
              maxItems: 500
              minItems: 0
              type: array
            DataSetSchema:
              additionalProperties: false
              description: <p>Dataset schema.</p>
              properties:
                ColumnSchemaList:
                  description: <p>A structure containing the list of column schemas.</p>
                  items:
                    additionalProperties: false
                    description: <p>The column schema.</p>
                    properties:
                      DataType:
                        description: <p>The data type of the column schema.</p>
                        type: string
                      GeographicRole:
                        description: <p>The geographic role of the column schema.</p>
                        type: string
                      Name:
                        description: <p>The name of the column schema.</p>
                        type: string
                    type: object
                  maxItems: 500
                  minItems: 0
                  type: array
              type: object
            Placeholder:
              description: <p>Placeholder.</p>
              type: string
          type: object
        maxItems: 30
        minItems: 0
        type: array
      Description:
        description: <p>The description of the template.</p>
        maxLength: 512
        minLength: 1
        type: string
      Errors:
        description: <p>Errors associated with this template version.</p>
        items:
          additionalProperties: false
          description: <p>List of errors that occurred when the template version creation
            failed.</p>
          properties:
            Message:
              description: <p>Description of the error type.</p>
              pattern: .*\S.*
              type: string
            Type:
              enum:
              - SOURCE_NOT_FOUND
              - DATA_SET_NOT_FOUND
              - INTERNAL_FAILURE
              - ACCESS_DENIED
              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>The Amazon Resource Name (ARN) of an analysis or template\
          \ that was used to create this\n            template.</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 this version of the template.</p>
        type: string
      VersionNumber:
        description: <p>The version number of the template version.</p>
        minimum: 1
        type: number
    type: object
properties:
  Name:
    description: <p>A display name for the template.</p>
    maxLength: 2048
    minLength: 1
    pattern: '[\u0020-\u00FF]+'
    type: string
  Permissions:
    description: <p>A list of resource permissions to be set on the template. </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>The source entity of the template.</p>
    properties:
      SourceAnalysis:
        additionalProperties: false
        description: <p>The source analysis of the template.</p>
        properties:
          Arn:
            description: <p>The Amazon Resource Name (ARN) of the resource.</p>
            type: string
          DataSetReferences:
            description: "<p>A structure containing information about the dataset\
              \ references used as placeholders\n            in the template.</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
      SourceTemplate:
        additionalProperties: false
        description: <p>The source template of the template.</p>
        properties:
          Arn:
            description: <p>The Amazon Resource Name (ARN) of the resource.</p>
            type: string
        required:
        - Arn
        type: object
    type: object
  Tags:
    description: <p>Contains a map of the key-value pairs for the resource tag or
      tags assigned to the resource.</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
  VersionDescription:
    description: "<p>A description of the current template version being created.\
      \ This API operation creates the\n\t\t\tfirst version of the template. Every\
      \ time <code>UpdateTemplate</code> is called, a new\n\t\t\tversion is created.\
      \ Each version of the template maintains a description of the version\n\t\t\t\
      in the <code>VersionDescription</code> field.</p>"
    maxLength: 512
    minLength: 1
    type: string
  type:
    enum:
    - update

Permissions - quicksight:UpdateTemplate, quicksight:UpdateTemplatePermissions, quicksight:DescribeAnalysis, quicksight:TagResource, quicksight:UntagResource, quicksight:ListTagsForResource