Amazon QuickSight

2024/09/19 - Amazon QuickSight - 1 new 9 updated api methods

Changes  QuickSight: 1. Add new API - ListFoldersForResource. 2. Commit mode adds visibility configuration of Apply button on multi-select controls for authors.

ListFoldersForResource (new) Link ¶

List all folders that a resource is a member of.

See also: AWS API Documentation

Request Syntax

client.list_folders_for_resource(
    AwsAccountId='string',
    ResourceArn='string',
    NextToken='string',
    MaxResults=123
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID for the Amazon Web Services account that contains the resource.

type ResourceArn

string

param ResourceArn

[REQUIRED]

The Amazon Resource Name (ARN) the resource whose folders you need to list.

type NextToken

string

param NextToken

The token for the next set of results, or null if there are no more results.

type MaxResults

integer

param MaxResults

The maximum number of results to be returned per request.

rtype

dict

returns

Response Syntax

{
    'Status': 123,
    'Folders': [
        'string',
    ],
    'NextToken': 'string',
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Status (integer) --

      The HTTP status of the request.

    • Folders (list) --

      A list that contains the Amazon Resource Names (ARNs) of all folders that the resource is a member of.

      • (string) --

    • NextToken (string) --

      The token for the next set of results, or null if there are no more results.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateAnalysis (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition .

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'AnalysisId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN for the analysis.

    • AnalysisId (string) --

      The ID of the analysis.

    • CreationStatus (string) --

      The status of the creation of the analysis.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateDashboard (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Creates a dashboard from either a template or directly with a DashboardDefinition . To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'VersionArn': 'string',
    'DashboardId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN of the dashboard.

    • VersionArn (string) --

      The ARN of the dashboard, including the version number of the first version that is created.

    • DashboardId (string) --

      The ID for the dashboard.

    • CreationStatus (string) --

      The status of the dashboard creation request.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

CreateTemplate (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses.

A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'VersionArn': 'string',
    'TemplateId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN for the template.

    • VersionArn (string) --

      The ARN for the template, including the version information of the first version.

    • TemplateId (string) --

      The ID of the template.

    • CreationStatus (string) --

      The template creation status.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

DescribeAnalysisDefinition (updated) Link ¶
Changes (response)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Provides a detailed description of the definition of an analysis.

Note

If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.

See also: AWS API Documentation

Request Syntax

client.describe_analysis_definition(
    AwsAccountId='string',
    AnalysisId='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.

type AnalysisId

string

param AnalysisId

[REQUIRED]

The ID of the analysis that you're describing. The ID is part of the URL of the analysis.

rtype

dict

returns

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

DescribeDashboardDefinition (updated) Link ¶
Changes (response)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Provides a detailed description of the definition of a dashboard.

Note

If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.

See also: AWS API Documentation

Request Syntax

client.describe_dashboard_definition(
    AwsAccountId='string',
    DashboardId='string',
    VersionNumber=123,
    AliasName='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that contains the dashboard that you're describing.

type DashboardId

string

param DashboardId

[REQUIRED]

The ID for the dashboard.

type VersionNumber

integer

param VersionNumber

The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

type AliasName

string

param AliasName

The alias name.

rtype

dict

returns

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

DescribeTemplateDefinition (updated) Link ¶
Changes (response)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Provides a detailed description of the definition of a template.

Note

If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.

See also: AWS API Documentation

Request Syntax

client.describe_template_definition(
    AwsAccountId='string',
    TemplateId='string',
    VersionNumber=123,
    AliasName='string'
)
type AwsAccountId

string

param AwsAccountId

[REQUIRED]

The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.

type TemplateId

string

param TemplateId

[REQUIRED]

The ID of the template that you're describing.

type VersionNumber

integer

param VersionNumber

The version number of the template.

type AliasName

string

param AliasName

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

rtype

dict

returns

Response Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Response Structure

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

UpdateAnalysis (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Updates an analysis in Amazon QuickSight

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'AnalysisId': 'string',
    'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The ARN of the analysis that you're updating.

    • AnalysisId (string) --

      The ID of the analysis.

    • UpdateStatus (string) --

      The update status of the last update that was made to the analysis.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateDashboard (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Updates a dashboard in an Amazon Web Services account.

Note

Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'Arn': 'string',
    'VersionArn': 'string',
    'DashboardId': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • Arn (string) --

      The Amazon Resource Name (ARN) of the resource.

    • VersionArn (string) --

      The ARN of the dashboard, including the version number.

    • DashboardId (string) --

      The ID for the dashboard.

    • CreationStatus (string) --

      The creation status of the request.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.

UpdateTemplate (updated) Link ¶
Changes (request)
{'Definition': {'FilterGroups': {'Filters': {'CategoryFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                        '| '
                                                                                                                                                                        'MANUAL'},
                                                                                                                         'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                  '| '
                                                                                                                                                                  'MANUAL'},
                                                                                                                         'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                          '| '
                                                                                                                                                                          'MANUAL'}}}},
                                             'NestedFilter': {'InnerFilter': {'CategoryInnerFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                              '| '
                                                                                                                                                                                                              'MANUAL'},
                                                                                                                                                               'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                        '| '
                                                                                                                                                                                                        'MANUAL'},
                                                                                                                                                               'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                                                '| '
                                                                                                                                                                                                                'MANUAL'}}}}}},
                                             'NumericEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'},
                                                                                                                                'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                                'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                                 '| '
                                                                                                                                                                                 'MANUAL'}}}},
                                             'NumericRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'RelativeDatesFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                             '| '
                                                                                                                                                                             'MANUAL'},
                                                                                                                              'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                       '| '
                                                                                                                                                                       'MANUAL'},
                                                                                                                              'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                               '| '
                                                                                                                                                                               'MANUAL'}}}},
                                             'TimeEqualityFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                            '| '
                                                                                                                                                                            'MANUAL'},
                                                                                                                             'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                      '| '
                                                                                                                                                                      'MANUAL'},
                                                                                                                             'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                              '| '
                                                                                                                                                                              'MANUAL'}}}},
                                             'TimeRangeFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}},
                                             'TopBottomFilter': {'DefaultFilterControlConfiguration': {'ControlOptions': {'DefaultDateTimePickerOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                         '| '
                                                                                                                                                                         'MANUAL'},
                                                                                                                          'DefaultDropdownOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                   '| '
                                                                                                                                                                   'MANUAL'},
                                                                                                                          'DefaultRelativeDateTimeOptions': {'CommitMode': 'AUTO '
                                                                                                                                                                           '| '
                                                                                                                                                                           'MANUAL'}}}}}},
                'Sheets': {'FilterControls': {'DateTimePicker': {'CommitMode': 'AUTO '
                                                                               '| '
                                                                               'MANUAL'},
                                              'Dropdown': {'CommitMode': 'AUTO '
                                                                         '| '
                                                                         'MANUAL'},
                                              'RelativeDateTime': {'CommitMode': 'AUTO '
                                                                                 '| '
                                                                                 'MANUAL'}},
                           'ParameterControls': {'Dropdown': {'CommitMode': 'AUTO '
                                                                            '| '
                                                                            'MANUAL'}}}}}

Updates a template from an existing Amazon QuickSight analysis or another template.

See also: AWS API Documentation

Request Syntax

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

Parameters

# This section is too large to render.
# Please see the AWS API Documentation linked below.

AWS API Documentation

rtype

dict

returns

Response Syntax

{
    'TemplateId': 'string',
    'Arn': 'string',
    'VersionArn': 'string',
    'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) --

    • TemplateId (string) --

      The ID for the template.

    • Arn (string) --

      The Amazon Resource Name (ARN) for the template.

    • VersionArn (string) --

      The ARN for the template, including the version information of the first version.

    • CreationStatus (string) --

      The creation status of the template.

    • Status (integer) --

      The HTTP status of the request.

    • RequestId (string) --

      The Amazon Web Services request ID for this operation.