Skip to content

Typed dictionaries

Index > QuickSight > Typed dictionaries

Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.

AccountCustomizationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AccountCustomizationTypeDef

def get_value() -> AccountCustomizationTypeDef:
    return {
        "DefaultTheme": ...,
    }
Definition
class AccountCustomizationTypeDef(TypedDict):
    DefaultTheme: NotRequired[str],
    DefaultEmailCustomizationTemplate: NotRequired[str],

AccountInfoTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AccountInfoTypeDef

def get_value() -> AccountInfoTypeDef:
    return {
        "AccountName": ...,
    }
Definition
class AccountInfoTypeDef(TypedDict):
    AccountName: NotRequired[str],
    Edition: NotRequired[EditionType],  # (1)
    NotificationEmail: NotRequired[str],
    AuthenticationType: NotRequired[str],
    AccountSubscriptionStatus: NotRequired[str],
  1. See EditionType

AccountSettingsTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AccountSettingsTypeDef

def get_value() -> AccountSettingsTypeDef:
    return {
        "AccountName": ...,
    }
Definition
class AccountSettingsTypeDef(TypedDict):
    AccountName: NotRequired[str],
    Edition: NotRequired[EditionType],  # (1)
    DefaultNamespace: NotRequired[str],
    NotificationEmail: NotRequired[str],
    PublicSharingEnabled: NotRequired[bool],
    TerminationProtectionEnabled: NotRequired[bool],
  1. See EditionType

ActiveIAMPolicyAssignmentTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import ActiveIAMPolicyAssignmentTypeDef

def get_value() -> ActiveIAMPolicyAssignmentTypeDef:
    return {
        "AssignmentName": ...,
    }
Definition
class ActiveIAMPolicyAssignmentTypeDef(TypedDict):
    AssignmentName: NotRequired[str],
    PolicyArn: NotRequired[str],

AdHocFilteringOptionTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AdHocFilteringOptionTypeDef

def get_value() -> AdHocFilteringOptionTypeDef:
    return {
        "AvailabilityStatus": ...,
    }
Definition
class AdHocFilteringOptionTypeDef(TypedDict):
    AvailabilityStatus: NotRequired[DashboardBehaviorType],  # (1)
  1. See DashboardBehaviorType

ColumnIdentifierTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import ColumnIdentifierTypeDef

def get_value() -> ColumnIdentifierTypeDef:
    return {
        "DataSetIdentifier": ...,
        "ColumnName": ...,
    }
Definition
class ColumnIdentifierTypeDef(TypedDict):
    DataSetIdentifier: str,
    ColumnName: str,

AmazonElasticsearchParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AmazonElasticsearchParametersTypeDef

def get_value() -> AmazonElasticsearchParametersTypeDef:
    return {
        "Domain": ...,
    }
Definition
class AmazonElasticsearchParametersTypeDef(TypedDict):
    Domain: str,

AmazonOpenSearchParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AmazonOpenSearchParametersTypeDef

def get_value() -> AmazonOpenSearchParametersTypeDef:
    return {
        "Domain": ...,
    }
Definition
class AmazonOpenSearchParametersTypeDef(TypedDict):
    Domain: str,

CalculatedFieldTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import CalculatedFieldTypeDef

def get_value() -> CalculatedFieldTypeDef:
    return {
        "DataSetIdentifier": ...,
        "Name": ...,
        "Expression": ...,
    }
Definition
class CalculatedFieldTypeDef(TypedDict):
    DataSetIdentifier: str,
    Name: str,
    Expression: str,

DataSetIdentifierDeclarationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import DataSetIdentifierDeclarationTypeDef

def get_value() -> DataSetIdentifierDeclarationTypeDef:
    return {
        "Identifier": ...,
        "DataSetArn": ...,
    }
Definition
class DataSetIdentifierDeclarationTypeDef(TypedDict):
    Identifier: str,
    DataSetArn: str,

EntityTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import EntityTypeDef

def get_value() -> EntityTypeDef:
    return {
        "Path": ...,
    }
Definition
class EntityTypeDef(TypedDict):
    Path: NotRequired[str],

AnalysisSearchFilterTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AnalysisSearchFilterTypeDef

def get_value() -> AnalysisSearchFilterTypeDef:
    return {
        "Operator": ...,
    }
Definition
class AnalysisSearchFilterTypeDef(TypedDict):
    Operator: NotRequired[FilterOperatorType],  # (1)
    Name: NotRequired[AnalysisFilterAttributeType],  # (2)
    Value: NotRequired[str],
  1. See FilterOperatorType
  2. See AnalysisFilterAttributeType

DataSetReferenceTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import DataSetReferenceTypeDef

def get_value() -> DataSetReferenceTypeDef:
    return {
        "DataSetPlaceholder": ...,
        "DataSetArn": ...,
    }
Definition
class DataSetReferenceTypeDef(TypedDict):
    DataSetPlaceholder: str,
    DataSetArn: str,

AnalysisSummaryTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AnalysisSummaryTypeDef

def get_value() -> AnalysisSummaryTypeDef:
    return {
        "Arn": ...,
    }
Definition
class AnalysisSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    AnalysisId: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[ResourceStatusType],  # (1)
    CreatedTime: NotRequired[datetime],
    LastUpdatedTime: NotRequired[datetime],
  1. See ResourceStatusType

SheetTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import SheetTypeDef

def get_value() -> SheetTypeDef:
    return {
        "SheetId": ...,
    }
Definition
class SheetTypeDef(TypedDict):
    SheetId: NotRequired[str],
    Name: NotRequired[str],

AnchorDateConfigurationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AnchorDateConfigurationTypeDef

def get_value() -> AnchorDateConfigurationTypeDef:
    return {
        "AnchorOption": ...,
    }
Definition
class AnchorDateConfigurationTypeDef(TypedDict):
    AnchorOption: NotRequired[AnchorOptionType],  # (1)
    ParameterName: NotRequired[str],
  1. See AnchorOptionType

AnonymousUserDashboardEmbeddingConfigurationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AnonymousUserDashboardEmbeddingConfigurationTypeDef

def get_value() -> AnonymousUserDashboardEmbeddingConfigurationTypeDef:
    return {
        "InitialDashboardId": ...,
    }
Definition
class AnonymousUserDashboardEmbeddingConfigurationTypeDef(TypedDict):
    InitialDashboardId: str,

DashboardVisualIdTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import DashboardVisualIdTypeDef

def get_value() -> DashboardVisualIdTypeDef:
    return {
        "DashboardId": ...,
        "SheetId": ...,
        "VisualId": ...,
    }
Definition
class DashboardVisualIdTypeDef(TypedDict):
    DashboardId: str,
    SheetId: str,
    VisualId: str,

AnonymousUserQSearchBarEmbeddingConfigurationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AnonymousUserQSearchBarEmbeddingConfigurationTypeDef

def get_value() -> AnonymousUserQSearchBarEmbeddingConfigurationTypeDef:
    return {
        "InitialTopicId": ...,
    }
Definition
class AnonymousUserQSearchBarEmbeddingConfigurationTypeDef(TypedDict):
    InitialTopicId: str,

ArcAxisDisplayRangeTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import ArcAxisDisplayRangeTypeDef

def get_value() -> ArcAxisDisplayRangeTypeDef:
    return {
        "Min": ...,
    }
Definition
class ArcAxisDisplayRangeTypeDef(TypedDict):
    Min: NotRequired[float],
    Max: NotRequired[float],

ArcConfigurationTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import ArcConfigurationTypeDef

def get_value() -> ArcConfigurationTypeDef:
    return {
        "ArcAngle": ...,
    }
Definition
class ArcConfigurationTypeDef(TypedDict):
    ArcAngle: NotRequired[float],
    ArcThickness: NotRequired[ArcThicknessOptionsType],  # (1)
  1. See ArcThicknessOptionsType

ArcOptionsTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import ArcOptionsTypeDef

def get_value() -> ArcOptionsTypeDef:
    return {
        "ArcThickness": ...,
    }
Definition
class ArcOptionsTypeDef(TypedDict):
    ArcThickness: NotRequired[ArcThicknessType],  # (1)
  1. See ArcThicknessType

AthenaParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AthenaParametersTypeDef

def get_value() -> AthenaParametersTypeDef:
    return {
        "WorkGroup": ...,
    }
Definition
class AthenaParametersTypeDef(TypedDict):
    WorkGroup: NotRequired[str],
    RoleArn: NotRequired[str],

AuroraParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AuroraParametersTypeDef

def get_value() -> AuroraParametersTypeDef:
    return {
        "Host": ...,
        "Port": ...,
        "Database": ...,
    }
Definition
class AuroraParametersTypeDef(TypedDict):
    Host: str,
    Port: int,
    Database: str,

AuroraPostgreSqlParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AuroraPostgreSqlParametersTypeDef

def get_value() -> AuroraPostgreSqlParametersTypeDef:
    return {
        "Host": ...,
        "Port": ...,
        "Database": ...,
    }
Definition
class AuroraPostgreSqlParametersTypeDef(TypedDict):
    Host: str,
    Port: int,
    Database: str,

AwsIotAnalyticsParametersTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import AwsIotAnalyticsParametersTypeDef

def get_value() -> AwsIotAnalyticsParametersTypeDef:
    return {
        "DataSetName": ...,
    }
Definition
class AwsIotAnalyticsParametersTypeDef(TypedDict):
    DataSetName: str,

DateAxisOptionsTypeDef

Usage Example
from mypy_boto3_quicksight.type_defs import DateAxisOptionsTypeDef

def get_value() -> DateAxisOptionsTypeDef:
    return {
        "MissingDateVisibility": ...,
    }
Definition
class DateAxisOptionsTypeDef(TypedDict):
    MissingDateVisibility: NotRequired[VisibilityType],  # (1)
  1. See VisibilityType

AxisDisplayMinMaxRangeTypeDef

Usage Example
from mypy_b