Type definitions#
Index > QuickSight > Type definitions
Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.
BlobTypeDef#
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AccountCustomizationTypeDef#
# AccountCustomizationTypeDef definition
class AccountCustomizationTypeDef(TypedDict):
DefaultTheme: NotRequired[str],
DefaultEmailCustomizationTemplate: NotRequired[str],
AccountInfoTypeDef#
# AccountInfoTypeDef definition
class AccountInfoTypeDef(TypedDict):
AccountName: NotRequired[str],
Edition: NotRequired[EditionType], # (1)
NotificationEmail: NotRequired[str],
AuthenticationType: NotRequired[str],
AccountSubscriptionStatus: NotRequired[str],
IAMIdentityCenterInstanceArn: NotRequired[str],
- See EditionType
AccountSettingsTypeDef#
# AccountSettingsTypeDef definition
class AccountSettingsTypeDef(TypedDict):
AccountName: NotRequired[str],
Edition: NotRequired[EditionType], # (1)
DefaultNamespace: NotRequired[str],
NotificationEmail: NotRequired[str],
PublicSharingEnabled: NotRequired[bool],
TerminationProtectionEnabled: NotRequired[bool],
- See EditionType
ActiveIAMPolicyAssignmentTypeDef#
# ActiveIAMPolicyAssignmentTypeDef definition
class ActiveIAMPolicyAssignmentTypeDef(TypedDict):
AssignmentName: NotRequired[str],
PolicyArn: NotRequired[str],
AdHocFilteringOptionTypeDef#
# AdHocFilteringOptionTypeDef definition
class AdHocFilteringOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
AttributeAggregationFunctionTypeDef#
# AttributeAggregationFunctionTypeDef definition
class AttributeAggregationFunctionTypeDef(TypedDict):
SimpleAttributeAggregation: NotRequired[SimpleAttributeAggregationFunctionType], # (1)
ValueForMultipleValues: NotRequired[str],
ColumnIdentifierTypeDef#
# ColumnIdentifierTypeDef definition
class ColumnIdentifierTypeDef(TypedDict):
DataSetIdentifier: str,
ColumnName: str,
AmazonElasticsearchParametersTypeDef#
# AmazonElasticsearchParametersTypeDef definition
class AmazonElasticsearchParametersTypeDef(TypedDict):
Domain: str,
AmazonOpenSearchParametersTypeDef#
# AmazonOpenSearchParametersTypeDef definition
class AmazonOpenSearchParametersTypeDef(TypedDict):
Domain: str,
AssetOptionsTypeDef#
# AssetOptionsTypeDef definition
class AssetOptionsTypeDef(TypedDict):
Timezone: NotRequired[str],
WeekStart: NotRequired[DayOfTheWeekType], # (1)
- See DayOfTheWeekType
CalculatedFieldTypeDef#
# CalculatedFieldTypeDef definition
class CalculatedFieldTypeDef(TypedDict):
DataSetIdentifier: str,
Name: str,
Expression: str,
DataSetIdentifierDeclarationTypeDef#
# DataSetIdentifierDeclarationTypeDef definition
class DataSetIdentifierDeclarationTypeDef(TypedDict):
Identifier: str,
DataSetArn: str,
EntityTypeDef#
# EntityTypeDef definition
class EntityTypeDef(TypedDict):
Path: NotRequired[str],
AnalysisSearchFilterTypeDef#
# AnalysisSearchFilterTypeDef definition
class AnalysisSearchFilterTypeDef(TypedDict):
Operator: NotRequired[FilterOperatorType], # (1)
Name: NotRequired[AnalysisFilterAttributeType], # (2)
Value: NotRequired[str],
DataSetReferenceTypeDef#
# DataSetReferenceTypeDef definition
class DataSetReferenceTypeDef(TypedDict):
DataSetPlaceholder: str,
DataSetArn: str,
AnalysisSummaryTypeDef#
# AnalysisSummaryTypeDef definition
class AnalysisSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
AnalysisId: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[ResourceStatusType], # (1)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
SheetTypeDef#
# SheetTypeDef definition
class SheetTypeDef(TypedDict):
SheetId: NotRequired[str],
Name: NotRequired[str],
AnchorDateConfigurationTypeDef#
# AnchorDateConfigurationTypeDef definition
class AnchorDateConfigurationTypeDef(TypedDict):
AnchorOption: NotRequired[AnchorOptionType], # (1)
ParameterName: NotRequired[str],
- See AnchorOptionType
AnonymousUserDashboardEmbeddingConfigurationTypeDef#
# AnonymousUserDashboardEmbeddingConfigurationTypeDef definition
class AnonymousUserDashboardEmbeddingConfigurationTypeDef(TypedDict):
InitialDashboardId: str,
DashboardVisualIdTypeDef#
# DashboardVisualIdTypeDef definition
class DashboardVisualIdTypeDef(TypedDict):
DashboardId: str,
SheetId: str,
VisualId: str,
AnonymousUserQSearchBarEmbeddingConfigurationTypeDef#
# AnonymousUserQSearchBarEmbeddingConfigurationTypeDef definition
class AnonymousUserQSearchBarEmbeddingConfigurationTypeDef(TypedDict):
InitialTopicId: str,
ArcAxisDisplayRangeTypeDef#
# ArcAxisDisplayRangeTypeDef definition
class ArcAxisDisplayRangeTypeDef(TypedDict):
Min: NotRequired[float],
Max: NotRequired[float],
ArcConfigurationTypeDef#
# ArcConfigurationTypeDef definition
class ArcConfigurationTypeDef(TypedDict):
ArcAngle: NotRequired[float],
ArcThickness: NotRequired[ArcThicknessOptionsType], # (1)
ArcOptionsTypeDef#
# ArcOptionsTypeDef definition
class ArcOptionsTypeDef(TypedDict):
ArcThickness: NotRequired[ArcThicknessType], # (1)
- See ArcThicknessType
AssetBundleExportJobAnalysisOverridePropertiesTypeDef#
# AssetBundleExportJobAnalysisOverridePropertiesTypeDef definition
class AssetBundleExportJobAnalysisOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobAnalysisPropertyToOverrideType], # (1)
AssetBundleExportJobDashboardOverridePropertiesTypeDef#
# AssetBundleExportJobDashboardOverridePropertiesTypeDef definition
class AssetBundleExportJobDashboardOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobDashboardPropertyToOverrideType], # (1)
AssetBundleExportJobDataSetOverridePropertiesTypeDef#
# AssetBundleExportJobDataSetOverridePropertiesTypeDef definition
class AssetBundleExportJobDataSetOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobDataSetPropertyToOverrideType], # (1)
AssetBundleExportJobDataSourceOverridePropertiesTypeDef#
# AssetBundleExportJobDataSourceOverridePropertiesTypeDef definition
class AssetBundleExportJobDataSourceOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobDataSourcePropertyToOverrideType], # (1)
AssetBundleExportJobRefreshScheduleOverridePropertiesTypeDef#
# AssetBundleExportJobRefreshScheduleOverridePropertiesTypeDef definition
class AssetBundleExportJobRefreshScheduleOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobRefreshSchedulePropertyToOverrideType], # (1)
AssetBundleExportJobResourceIdOverrideConfigurationTypeDef#
# AssetBundleExportJobResourceIdOverrideConfigurationTypeDef definition
class AssetBundleExportJobResourceIdOverrideConfigurationTypeDef(TypedDict):
PrefixForAllResources: NotRequired[bool],
AssetBundleExportJobThemeOverridePropertiesTypeDef#
# AssetBundleExportJobThemeOverridePropertiesTypeDef definition
class AssetBundleExportJobThemeOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobThemePropertyToOverrideType], # (1)
AssetBundleExportJobVPCConnectionOverridePropertiesTypeDef#
# AssetBundleExportJobVPCConnectionOverridePropertiesTypeDef definition
class AssetBundleExportJobVPCConnectionOverridePropertiesTypeDef(TypedDict):
Arn: str,
Properties: List[AssetBundleExportJobVPCConnectionPropertyToOverrideType], # (1)
AssetBundleExportJobErrorTypeDef#
# AssetBundleExportJobErrorTypeDef definition
class AssetBundleExportJobErrorTypeDef(TypedDict):
Arn: NotRequired[str],
Type: NotRequired[str],
Message: NotRequired[str],
AssetBundleExportJobSummaryTypeDef#
# AssetBundleExportJobSummaryTypeDef definition
class AssetBundleExportJobSummaryTypeDef(TypedDict):
JobStatus: NotRequired[AssetBundleExportJobStatusType], # (1)
Arn: NotRequired[str],
CreatedTime: NotRequired[datetime],
AssetBundleExportJobId: NotRequired[str],
IncludeAllDependencies: NotRequired[bool],
ExportFormat: NotRequired[AssetBundleExportFormatType], # (2)
IncludePermissions: NotRequired[bool],
IncludeTags: NotRequired[bool],
AssetBundleExportJobValidationStrategyTypeDef#
# AssetBundleExportJobValidationStrategyTypeDef definition
class AssetBundleExportJobValidationStrategyTypeDef(TypedDict):
StrictModeForAllResources: NotRequired[bool],
AssetBundleExportJobWarningTypeDef#
# AssetBundleExportJobWarningTypeDef definition
class AssetBundleExportJobWarningTypeDef(TypedDict):
Arn: NotRequired[str],
Message: NotRequired[str],
AssetBundleImportJobAnalysisOverrideParametersTypeDef#
# AssetBundleImportJobAnalysisOverrideParametersTypeDef definition
class AssetBundleImportJobAnalysisOverrideParametersTypeDef(TypedDict):
AnalysisId: str,
Name: NotRequired[str],
AssetBundleResourcePermissionsTypeDef#
# AssetBundleResourcePermissionsTypeDef definition
class AssetBundleResourcePermissionsTypeDef(TypedDict):
Principals: List[str],
Actions: List[str],
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
AssetBundleImportJobDashboardOverrideParametersTypeDef#
# AssetBundleImportJobDashboardOverrideParametersTypeDef definition
class AssetBundleImportJobDashboardOverrideParametersTypeDef(TypedDict):
DashboardId: str,
Name: NotRequired[str],
AssetBundleImportJobDataSetOverrideParametersTypeDef#
# AssetBundleImportJobDataSetOverrideParametersTypeDef definition
class AssetBundleImportJobDataSetOverrideParametersTypeDef(TypedDict):
DataSetId: str,
Name: NotRequired[str],
AssetBundleImportJobDataSourceCredentialPairTypeDef#
# AssetBundleImportJobDataSourceCredentialPairTypeDef definition
class AssetBundleImportJobDataSourceCredentialPairTypeDef(TypedDict):
Username: str,
Password: str,
SslPropertiesTypeDef#
# SslPropertiesTypeDef definition
class SslPropertiesTypeDef(TypedDict):
DisableSsl: NotRequired[bool],
VpcConnectionPropertiesTypeDef#
# VpcConnectionPropertiesTypeDef definition
class VpcConnectionPropertiesTypeDef(TypedDict):
VpcConnectionArn: str,
AssetBundleImportJobErrorTypeDef#
# AssetBundleImportJobErrorTypeDef definition
class AssetBundleImportJobErrorTypeDef(TypedDict):
Arn: NotRequired[str],
Type: NotRequired[str],
Message: NotRequired[str],
AssetBundleImportJobRefreshScheduleOverrideParametersTypeDef#
# AssetBundleImportJobRefreshScheduleOverrideParametersTypeDef definition
class AssetBundleImportJobRefreshScheduleOverrideParametersTypeDef(TypedDict):
DataSetId: str,
ScheduleId: str,
StartAfterDateTime: NotRequired[datetime],
AssetBundleImportJobResourceIdOverrideConfigurationTypeDef#
# AssetBundleImportJobResourceIdOverrideConfigurationTypeDef definition
class AssetBundleImportJobResourceIdOverrideConfigurationTypeDef(TypedDict):
PrefixForAllResources: NotRequired[str],
AssetBundleImportJobThemeOverrideParametersTypeDef#
# AssetBundleImportJobThemeOverrideParametersTypeDef definition
class AssetBundleImportJobThemeOverrideParametersTypeDef(TypedDict):
ThemeId: str,
Name: NotRequired[str],
AssetBundleImportJobVPCConnectionOverrideParametersTypeDef#
# AssetBundleImportJobVPCConnectionOverrideParametersTypeDef definition
class AssetBundleImportJobVPCConnectionOverrideParametersTypeDef(TypedDict):
VPCConnectionId: str,
Name: NotRequired[str],
SubnetIds: NotRequired[List[str]],
SecurityGroupIds: NotRequired[List[str]],
DnsResolvers: NotRequired[List[str]],
RoleArn: NotRequired[str],
AssetBundleImportJobOverrideValidationStrategyTypeDef#
# AssetBundleImportJobOverrideValidationStrategyTypeDef definition
class AssetBundleImportJobOverrideValidationStrategyTypeDef(TypedDict):
StrictModeForAllResources: NotRequired[bool],
AssetBundleImportJobSummaryTypeDef#
# AssetBundleImportJobSummaryTypeDef definition
class AssetBundleImportJobSummaryTypeDef(TypedDict):
JobStatus: NotRequired[AssetBundleImportJobStatusType], # (1)
Arn: NotRequired[str],
CreatedTime: NotRequired[datetime],
AssetBundleImportJobId: NotRequired[str],
FailureAction: NotRequired[AssetBundleImportFailureActionType], # (2)
AssetBundleImportSourceDescriptionTypeDef#
# AssetBundleImportSourceDescriptionTypeDef definition
class AssetBundleImportSourceDescriptionTypeDef(TypedDict):
Body: NotRequired[str],
S3Uri: NotRequired[str],
AthenaParametersTypeDef#
# AthenaParametersTypeDef definition
class AthenaParametersTypeDef(TypedDict):
WorkGroup: NotRequired[str],
RoleArn: NotRequired[str],
AuroraParametersTypeDef#
# AuroraParametersTypeDef definition
class AuroraParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
AuroraPostgreSqlParametersTypeDef#
# AuroraPostgreSqlParametersTypeDef definition
class AuroraPostgreSqlParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
AuthorizedTargetsByServiceTypeDef#
# AuthorizedTargetsByServiceTypeDef definition
class AuthorizedTargetsByServiceTypeDef(TypedDict):
Service: NotRequired[ServiceTypeType], # (1)
AuthorizedTargets: NotRequired[List[str]],
- See ServiceTypeType
AwsIotAnalyticsParametersTypeDef#
# AwsIotAnalyticsParametersTypeDef definition
class AwsIotAnalyticsParametersTypeDef(TypedDict):
DataSetName: str,
DateAxisOptionsTypeDef#
# DateAxisOptionsTypeDef definition
class DateAxisOptionsTypeDef(TypedDict):
MissingDateVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
AxisDisplayMinMaxRangeTypeDef#
# AxisDisplayMinMaxRangeTypeDef definition
class AxisDisplayMinMaxRangeTypeDef(TypedDict):
Minimum: NotRequired[float],
Maximum: NotRequired[float],
AxisLinearScaleTypeDef#
# AxisLinearScaleTypeDef definition
class AxisLinearScaleTypeDef(TypedDict):
StepCount: NotRequired[int],
StepSize: NotRequired[float],
AxisLogarithmicScaleTypeDef#
# AxisLogarithmicScaleTypeDef definition
class AxisLogarithmicScaleTypeDef(TypedDict):
Base: NotRequired[float],
ItemsLimitConfigurationTypeDef#
# ItemsLimitConfigurationTypeDef definition
class ItemsLimitConfigurationTypeDef(TypedDict):
ItemsLimit: NotRequired[int],
OtherCategories: NotRequired[OtherCategoriesType], # (1)
BigQueryParametersTypeDef#
# BigQueryParametersTypeDef definition
class BigQueryParametersTypeDef(TypedDict):
ProjectId: str,
DataSetRegion: NotRequired[str],
BinCountOptionsTypeDef#
# BinCountOptionsTypeDef definition
class BinCountOptionsTypeDef(TypedDict):
Value: NotRequired[int],
BinWidthOptionsTypeDef#
# BinWidthOptionsTypeDef definition
class BinWidthOptionsTypeDef(TypedDict):
Value: NotRequired[float],
BinCountLimit: NotRequired[int],
BookmarksConfigurationsTypeDef#
# BookmarksConfigurationsTypeDef definition
class BookmarksConfigurationsTypeDef(TypedDict):
Enabled: bool,
BorderStyleTypeDef#
# BorderStyleTypeDef definition
class BorderStyleTypeDef(TypedDict):
Show: NotRequired[bool],
BoxPlotStyleOptionsTypeDef#
# BoxPlotStyleOptionsTypeDef definition
class BoxPlotStyleOptionsTypeDef(TypedDict):
FillStyle: NotRequired[BoxPlotFillStyleType], # (1)
PaginationConfigurationTypeDef#
# PaginationConfigurationTypeDef definition
class PaginationConfigurationTypeDef(TypedDict):
PageSize: int,
PageNumber: int,
CalculatedColumnTypeDef#
# CalculatedColumnTypeDef definition
class CalculatedColumnTypeDef(TypedDict):
ColumnName: str,
ColumnId: str,
Expression: str,
CalculatedMeasureFieldTypeDef#
# CalculatedMeasureFieldTypeDef definition
class CalculatedMeasureFieldTypeDef(TypedDict):
FieldId: str,
Expression: str,
CancelIngestionRequestRequestTypeDef#
# CancelIngestionRequestRequestTypeDef definition
class CancelIngestionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
CastColumnTypeOperationTypeDef#
# CastColumnTypeOperationTypeDef definition
class CastColumnTypeOperationTypeDef(TypedDict):
ColumnName: str,
NewColumnType: ColumnDataTypeType, # (1)
SubType: NotRequired[ColumnDataSubTypeType], # (2)
Format: NotRequired[str],
CustomFilterConfigurationTypeDef#
# CustomFilterConfigurationTypeDef definition
class CustomFilterConfigurationTypeDef(TypedDict):
MatchOperator: CategoryFilterMatchOperatorType, # (1)
NullOption: FilterNullOptionType, # (3)
CategoryValue: NotRequired[str],
SelectAllOptions: NotRequired[CategoryFilterSelectAllOptionsType], # (2)
ParameterName: NotRequired[str],
CustomFilterListConfigurationTypeDef#
# CustomFilterListConfigurationTypeDef definition
class CustomFilterListConfigurationTypeDef(TypedDict):
MatchOperator: CategoryFilterMatchOperatorType, # (1)
NullOption: FilterNullOptionType, # (3)
CategoryValues: NotRequired[Sequence[str]],
SelectAllOptions: NotRequired[CategoryFilterSelectAllOptionsType], # (2)
FilterListConfigurationTypeDef#
# FilterListConfigurationTypeDef definition
class FilterListConfigurationTypeDef(TypedDict):
MatchOperator: CategoryFilterMatchOperatorType, # (1)
CategoryValues: NotRequired[Sequence[str]],
SelectAllOptions: NotRequired[CategoryFilterSelectAllOptionsType], # (2)
NullOption: NotRequired[FilterNullOptionType], # (3)
CellValueSynonymTypeDef#
# CellValueSynonymTypeDef definition
class CellValueSynonymTypeDef(TypedDict):
CellValue: NotRequired[str],
Synonyms: NotRequired[Sequence[str]],
SimpleClusterMarkerTypeDef#
# SimpleClusterMarkerTypeDef definition
class SimpleClusterMarkerTypeDef(TypedDict):
Color: NotRequired[str],
CollectiveConstantTypeDef#
# CollectiveConstantTypeDef definition
class CollectiveConstantTypeDef(TypedDict):
ValueList: NotRequired[Sequence[str]],
DataColorTypeDef#
# DataColorTypeDef definition
class DataColorTypeDef(TypedDict):
Color: NotRequired[str],
DataValue: NotRequired[float],
CustomColorTypeDef#
# CustomColorTypeDef definition
class CustomColorTypeDef(TypedDict):
Color: str,
FieldValue: NotRequired[str],
SpecialValue: NotRequired[SpecialValueType], # (1)
- See SpecialValueType
ColumnDescriptionTypeDef#
# ColumnDescriptionTypeDef definition
class ColumnDescriptionTypeDef(TypedDict):
Text: NotRequired[str],
ColumnGroupColumnSchemaTypeDef#
# ColumnGroupColumnSchemaTypeDef definition
class ColumnGroupColumnSchemaTypeDef(TypedDict):
Name: NotRequired[str],
GeoSpatialColumnGroupTypeDef#
# GeoSpatialColumnGroupTypeDef definition
class GeoSpatialColumnGroupTypeDef(TypedDict):
Name: str,
Columns: Sequence[str],
CountryCode: NotRequired[GeoSpatialCountryCodeType], # (1)
ColumnLevelPermissionRuleTypeDef#
# ColumnLevelPermissionRuleTypeDef definition
class ColumnLevelPermissionRuleTypeDef(TypedDict):
Principals: NotRequired[Sequence[str]],
ColumnNames: NotRequired[Sequence[str]],
ColumnSchemaTypeDef#
# ColumnSchemaTypeDef definition
class ColumnSchemaTypeDef(TypedDict):
Name: NotRequired[str],
DataType: NotRequired[str],
GeographicRole: NotRequired[str],
ComparativeOrderTypeDef#
# ComparativeOrderTypeDef definition
class ComparativeOrderTypeDef(TypedDict):
UseOrdering: NotRequired[ColumnOrderingTypeType], # (1)
SpecifedOrder: NotRequired[Sequence[str]],
TreatUndefinedSpecifiedValues: NotRequired[UndefinedSpecifiedValueTypeType], # (2)
ConditionalFormattingSolidColorTypeDef#
# ConditionalFormattingSolidColorTypeDef definition
class ConditionalFormattingSolidColorTypeDef(TypedDict):
Expression: str,
Color: NotRequired[str],
ConditionalFormattingCustomIconOptionsTypeDef#
# ConditionalFormattingCustomIconOptionsTypeDef definition
class ConditionalFormattingCustomIconOptionsTypeDef(TypedDict):
Icon: NotRequired[IconType], # (1)
UnicodeIcon: NotRequired[str],
- See IconType
ConditionalFormattingIconDisplayConfigurationTypeDef#
# ConditionalFormattingIconDisplayConfigurationTypeDef definition
class ConditionalFormattingIconDisplayConfigurationTypeDef(TypedDict):
IconDisplayOption: NotRequired[ConditionalFormattingIconDisplayOptionType], # (1)
ConditionalFormattingIconSetTypeDef#
# ConditionalFormattingIconSetTypeDef definition
class ConditionalFormattingIconSetTypeDef(TypedDict):
Expression: str,
IconSetType: NotRequired[ConditionalFormattingIconSetTypeType], # (1)
ContextMenuOptionTypeDef#
# ContextMenuOptionTypeDef definition
class ContextMenuOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
CreateAccountSubscriptionRequestRequestTypeDef#
# CreateAccountSubscriptionRequestRequestTypeDef definition
class CreateAccountSubscriptionRequestRequestTypeDef(TypedDict):
Edition: EditionType, # (1)
AuthenticationMethod: AuthenticationMethodOptionType, # (2)
AwsAccountId: str,
AccountName: str,
NotificationEmail: str,
ActiveDirectoryName: NotRequired[str],
Realm: NotRequired[str],
DirectoryId: NotRequired[str],
AdminGroup: NotRequired[Sequence[str]],
AuthorGroup: NotRequired[Sequence[str]],
ReaderGroup: NotRequired[Sequence[str]],
FirstName: NotRequired[str],
LastName: NotRequired[str],
EmailAddress: NotRequired[str],
ContactNumber: NotRequired[str],
SignupResponseTypeDef#
# SignupResponseTypeDef definition
class SignupResponseTypeDef(TypedDict):
IAMUser: NotRequired[bool],
userLoginName: NotRequired[str],
accountName: NotRequired[str],
directoryType: NotRequired[str],
ResourcePermissionTypeDef#
# ResourcePermissionTypeDef definition
class ResourcePermissionTypeDef(TypedDict):
Principal: str,
Actions: Sequence[str],
ValidationStrategyTypeDef#
# ValidationStrategyTypeDef definition
class ValidationStrategyTypeDef(TypedDict):
Mode: ValidationStrategyModeType, # (1)
DataSetUsageConfigurationTypeDef#
# DataSetUsageConfigurationTypeDef definition
class DataSetUsageConfigurationTypeDef(TypedDict):
DisableUseAsDirectQuerySource: NotRequired[bool],
DisableUseAsImportedSource: NotRequired[bool],
FieldFolderTypeDef#
# FieldFolderTypeDef definition
class FieldFolderTypeDef(TypedDict):
description: NotRequired[str],
columns: NotRequired[Sequence[str]],
RowLevelPermissionDataSetTypeDef#
# RowLevelPermissionDataSetTypeDef definition
class RowLevelPermissionDataSetTypeDef(TypedDict):
Arn: str,
PermissionPolicy: RowLevelPermissionPolicyType, # (1)
Namespace: NotRequired[str],
FormatVersion: NotRequired[RowLevelPermissionFormatVersionType], # (2)
Status: NotRequired[StatusType], # (3)
CreateFolderMembershipRequestRequestTypeDef#
# CreateFolderMembershipRequestRequestTypeDef definition
class CreateFolderMembershipRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
- See MemberTypeType
FolderMemberTypeDef#
# FolderMemberTypeDef definition
class FolderMemberTypeDef(TypedDict):
MemberId: NotRequired[str],
MemberType: NotRequired[MemberTypeType], # (1)
- See MemberTypeType
CreateGroupMembershipRequestRequestTypeDef#
# CreateGroupMembershipRequestRequestTypeDef definition
class CreateGroupMembershipRequestRequestTypeDef(TypedDict):
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
GroupMemberTypeDef#
# GroupMemberTypeDef definition
class GroupMemberTypeDef(TypedDict):
Arn: NotRequired[str],
MemberName: NotRequired[str],
CreateGroupRequestRequestTypeDef#
# CreateGroupRequestRequestTypeDef definition
class CreateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: NotRequired[str],
GroupTypeDef#
# GroupTypeDef definition
class GroupTypeDef(TypedDict):
Arn: NotRequired[str],
GroupName: NotRequired[str],
Description: NotRequired[str],
PrincipalId: NotRequired[str],
CreateIAMPolicyAssignmentRequestRequestTypeDef#
# CreateIAMPolicyAssignmentRequestRequestTypeDef definition
class CreateIAMPolicyAssignmentRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssignmentName: str,
AssignmentStatus: AssignmentStatusType, # (1)
Namespace: str,
PolicyArn: NotRequired[str],
Identities: NotRequired[Mapping[str, Sequence[str]]],
CreateIngestionRequestRequestTypeDef#
# CreateIngestionRequestRequestTypeDef definition
class CreateIngestionRequestRequestTypeDef(TypedDict):
DataSetId: str,
IngestionId: str,
AwsAccountId: str,
IngestionType: NotRequired[IngestionTypeType], # (1)
CreateRoleMembershipRequestRequestTypeDef#
# CreateRoleMembershipRequestRequestTypeDef definition
class CreateRoleMembershipRequestRequestTypeDef(TypedDict):
MemberName: str,
AwsAccountId: str,
Namespace: str,
Role: RoleType, # (1)
- See RoleType
CreateTemplateAliasRequestRequestTypeDef#
# CreateTemplateAliasRequestRequestTypeDef definition
class CreateTemplateAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
TemplateAliasTypeDef#
# TemplateAliasTypeDef definition
class TemplateAliasTypeDef(TypedDict):
AliasName: NotRequired[str],
Arn: NotRequired[str],
TemplateVersionNumber: NotRequired[int],
CreateThemeAliasRequestRequestTypeDef#
# CreateThemeAliasRequestRequestTypeDef definition
class CreateThemeAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
ThemeAliasTypeDef#
# ThemeAliasTypeDef definition
class ThemeAliasTypeDef(TypedDict):
Arn: NotRequired[str],
AliasName: NotRequired[str],
ThemeVersionNumber: NotRequired[int],
DecimalPlacesConfigurationTypeDef#
# DecimalPlacesConfigurationTypeDef definition
class DecimalPlacesConfigurationTypeDef(TypedDict):
DecimalPlaces: int,
NegativeValueConfigurationTypeDef#
# NegativeValueConfigurationTypeDef definition
class NegativeValueConfigurationTypeDef(TypedDict):
DisplayMode: NegativeValueDisplayModeType, # (1)
NullValueFormatConfigurationTypeDef#
# NullValueFormatConfigurationTypeDef definition
class NullValueFormatConfigurationTypeDef(TypedDict):
NullString: str,
LocalNavigationConfigurationTypeDef#
# LocalNavigationConfigurationTypeDef definition
class LocalNavigationConfigurationTypeDef(TypedDict):
TargetSheetId: str,
CustomActionURLOperationTypeDef#
# CustomActionURLOperationTypeDef definition
class CustomActionURLOperationTypeDef(TypedDict):
URLTemplate: str,
URLTarget: URLTargetConfigurationType, # (1)
CustomNarrativeOptionsTypeDef#
# CustomNarrativeOptionsTypeDef definition
class CustomNarrativeOptionsTypeDef(TypedDict):
Narrative: str,
InputColumnTypeDef#
# InputColumnTypeDef definition
class InputColumnTypeDef(TypedDict):
Name: str,
Type: InputColumnDataTypeType, # (1)
SubType: NotRequired[ColumnDataSubTypeType], # (2)
DataPointDrillUpDownOptionTypeDef#
# DataPointDrillUpDownOptionTypeDef definition
class DataPointDrillUpDownOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
DataPointMenuLabelOptionTypeDef#
# DataPointMenuLabelOptionTypeDef definition
class DataPointMenuLabelOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
DataPointTooltipOptionTypeDef#
# DataPointTooltipOptionTypeDef definition
class DataPointTooltipOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
ExportToCSVOptionTypeDef#
# ExportToCSVOptionTypeDef definition
class ExportToCSVOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
ExportWithHiddenFieldsOptionTypeDef#
# ExportWithHiddenFieldsOptionTypeDef definition
class ExportWithHiddenFieldsOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
SheetControlsOptionTypeDef#
# SheetControlsOptionTypeDef definition
class SheetControlsOptionTypeDef(TypedDict):
VisibilityState: NotRequired[DashboardUIStateType], # (1)
SheetLayoutElementMaximizationOptionTypeDef#
# SheetLayoutElementMaximizationOptionTypeDef definition
class SheetLayoutElementMaximizationOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
VisualAxisSortOptionTypeDef#
# VisualAxisSortOptionTypeDef definition
class VisualAxisSortOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
VisualMenuOptionTypeDef#
# VisualMenuOptionTypeDef definition
class VisualMenuOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
DashboardSearchFilterTypeDef#
# DashboardSearchFilterTypeDef definition
class DashboardSearchFilterTypeDef(TypedDict):
Operator: FilterOperatorType, # (1)
Name: NotRequired[DashboardFilterAttributeType], # (2)
Value: NotRequired[str],
DashboardSummaryTypeDef#
# DashboardSummaryTypeDef definition
class DashboardSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
DashboardId: NotRequired[str],
Name: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
PublishedVersionNumber: NotRequired[int],
LastPublishedTime: NotRequired[datetime],
DashboardVersionSummaryTypeDef#
# DashboardVersionSummaryTypeDef definition
class DashboardVersionSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
CreatedTime: NotRequired[datetime],
VersionNumber: NotRequired[int],
Status: NotRequired[ResourceStatusType], # (1)
SourceEntityArn: NotRequired[str],
Description: NotRequired[str],
ExportHiddenFieldsOptionTypeDef#
# ExportHiddenFieldsOptionTypeDef definition
class ExportHiddenFieldsOptionTypeDef(TypedDict):
AvailabilityStatus: NotRequired[DashboardBehaviorType], # (1)
DataAggregationTypeDef#
# DataAggregationTypeDef definition
class DataAggregationTypeDef(TypedDict):
DatasetRowDateGranularity: NotRequired[TopicTimeGranularityType], # (1)
DefaultDateColumnName: NotRequired[str],
DataBarsOptionsTypeDef#
# DataBarsOptionsTypeDef definition
class DataBarsOptionsTypeDef(TypedDict):
FieldId: str,
PositiveColor: NotRequired[str],
NegativeColor: NotRequired[str],
DataColorPaletteTypeDef#
# DataColorPaletteTypeDef definition
class DataColorPaletteTypeDef(TypedDict):
Colors: NotRequired[Sequence[str]],
MinMaxGradient: NotRequired[Sequence[str]],
EmptyFillColor: NotRequired[str],
DataPathLabelTypeTypeDef#
# DataPathLabelTypeTypeDef definition
class DataPathLabelTypeTypeDef(TypedDict):
FieldId: NotRequired[str],
FieldValue: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
FieldLabelTypeTypeDef#
# FieldLabelTypeTypeDef definition
class FieldLabelTypeTypeDef(TypedDict):
FieldId: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
MaximumLabelTypeTypeDef#
# MaximumLabelTypeTypeDef definition
class MaximumLabelTypeTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
MinimumLabelTypeTypeDef#
# MinimumLabelTypeTypeDef definition
class MinimumLabelTypeTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
RangeEndsLabelTypeTypeDef#
# RangeEndsLabelTypeTypeDef definition
class RangeEndsLabelTypeTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
DataPathTypeTypeDef#
# DataPathTypeTypeDef definition
class DataPathTypeTypeDef(TypedDict):
PivotTableDataPathType: NotRequired[PivotTableDataPathTypeType], # (1)
DataSetSearchFilterTypeDef#
# DataSetSearchFilterTypeDef definition
class DataSetSearchFilterTypeDef(TypedDict):
Operator: FilterOperatorType, # (1)
Name: DataSetFilterAttributeType, # (2)
Value: str,
OutputColumnTypeDef#
# OutputColumnTypeDef definition
class OutputColumnTypeDef(TypedDict):
Name: NotRequired[str],
Description: NotRequired[str],
Type: NotRequired[ColumnDataTypeType], # (1)
SubType: NotRequired[ColumnDataSubTypeType], # (2)
DataSourceErrorInfoTypeDef#
# DataSourceErrorInfoTypeDef definition
class DataSourceErrorInfoTypeDef(TypedDict):
Type: NotRequired[DataSourceErrorInfoTypeType], # (1)
Message: NotRequired[str],
DatabricksParametersTypeDef#
# DatabricksParametersTypeDef definition
class DatabricksParametersTypeDef(TypedDict):
Host: str,
Port: int,
SqlEndpointPath: str,
ExasolParametersTypeDef#
# ExasolParametersTypeDef definition
class ExasolParametersTypeDef(TypedDict):
Host: str,
Port: int,
JiraParametersTypeDef#
# JiraParametersTypeDef definition
class JiraParametersTypeDef(TypedDict):
SiteBaseUrl: str,
MariaDbParametersTypeDef#
# MariaDbParametersTypeDef definition
class MariaDbParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
MySqlParametersTypeDef#
# MySqlParametersTypeDef definition
class MySqlParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
OracleParametersTypeDef#
# OracleParametersTypeDef definition
class OracleParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
PostgreSqlParametersTypeDef#
# PostgreSqlParametersTypeDef definition
class PostgreSqlParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
PrestoParametersTypeDef#
# PrestoParametersTypeDef definition
class PrestoParametersTypeDef(TypedDict):
Host: str,
Port: int,
Catalog: str,
RdsParametersTypeDef#
# RdsParametersTypeDef definition
class RdsParametersTypeDef(TypedDict):
InstanceId: str,
Database: str,
ServiceNowParametersTypeDef#
# ServiceNowParametersTypeDef definition
class ServiceNowParametersTypeDef(TypedDict):
SiteBaseUrl: str,
SnowflakeParametersTypeDef#
# SnowflakeParametersTypeDef definition
class SnowflakeParametersTypeDef(TypedDict):
Host: str,
Database: str,
Warehouse: str,
SparkParametersTypeDef#
# SparkParametersTypeDef definition
class SparkParametersTypeDef(TypedDict):
Host: str,
Port: int,
SqlServerParametersTypeDef#
# SqlServerParametersTypeDef definition
class SqlServerParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
StarburstParametersTypeDef#
# StarburstParametersTypeDef definition
class StarburstParametersTypeDef(TypedDict):
Host: str,
Port: int,
Catalog: str,
ProductType: NotRequired[StarburstProductTypeType], # (1)
TeradataParametersTypeDef#
# TeradataParametersTypeDef definition
class TeradataParametersTypeDef(TypedDict):
Host: str,
Port: int,
Database: str,
TrinoParametersTypeDef#
# TrinoParametersTypeDef definition
class TrinoParametersTypeDef(TypedDict):
Host: str,
Port: int,
Catalog: str,
TwitterParametersTypeDef#
# TwitterParametersTypeDef definition
class TwitterParametersTypeDef(TypedDict):
Query: str,
MaxRows: int,
DataSourceSearchFilterTypeDef#
# DataSourceSearchFilterTypeDef definition
class DataSourceSearchFilterTypeDef(TypedDict):
Operator: FilterOperatorType, # (1)
Name: DataSourceFilterAttributeType, # (2)
Value: str,
DataSourceSummaryTypeDef#
# DataSourceSummaryTypeDef definition
class DataSourceSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
DataSourceId: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[DataSourceTypeType], # (1)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
RollingDateConfigurationTypeDef#
# RollingDateConfigurationTypeDef definition
class RollingDateConfigurationTypeDef(TypedDict):
Expression: str,
DataSetIdentifier: NotRequired[str],
MappedDataSetParameterTypeDef#
# MappedDataSetParameterTypeDef definition
class MappedDataSetParameterTypeDef(TypedDict):
DataSetIdentifier: str,
DataSetParameterName: str,
SheetControlInfoIconLabelOptionsTypeDef#
# SheetControlInfoIconLabelOptionsTypeDef definition
class SheetControlInfoIconLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
InfoIconText: NotRequired[str],
- See VisibilityType
DecimalDatasetParameterDefaultValuesTypeDef#
# DecimalDatasetParameterDefaultValuesTypeDef definition
class DecimalDatasetParameterDefaultValuesTypeDef(TypedDict):
StaticValues: NotRequired[Sequence[float]],
DecimalValueWhenUnsetConfigurationTypeDef#
# DecimalValueWhenUnsetConfigurationTypeDef definition
class DecimalValueWhenUnsetConfigurationTypeDef(TypedDict):
ValueWhenUnsetOption: NotRequired[ValueWhenUnsetOptionType], # (1)
CustomValue: NotRequired[float],
DecimalParameterTypeDef#
# DecimalParameterTypeDef definition
class DecimalParameterTypeDef(TypedDict):
Name: str,
Values: Sequence[float],
DeleteAccountCustomizationRequestRequestTypeDef#
# DeleteAccountCustomizationRequestRequestTypeDef definition
class DeleteAccountCustomizationRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: NotRequired[str],
DeleteAccountSubscriptionRequestRequestTypeDef#
# DeleteAccountSubscriptionRequestRequestTypeDef definition
class DeleteAccountSubscriptionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DeleteAnalysisRequestRequestTypeDef#
# DeleteAnalysisRequestRequestTypeDef definition
class DeleteAnalysisRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
RecoveryWindowInDays: NotRequired[int],
ForceDeleteWithoutRecovery: NotRequired[bool],
DeleteDashboardRequestRequestTypeDef#
# DeleteDashboardRequestRequestTypeDef definition
class DeleteDashboardRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
VersionNumber: NotRequired[int],
DeleteDataSetRefreshPropertiesRequestRequestTypeDef#
# DeleteDataSetRefreshPropertiesRequestRequestTypeDef definition
class DeleteDataSetRefreshPropertiesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DeleteDataSetRequestRequestTypeDef#
# DeleteDataSetRequestRequestTypeDef definition
class DeleteDataSetRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DeleteDataSourceRequestRequestTypeDef#
# DeleteDataSourceRequestRequestTypeDef definition
class DeleteDataSourceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
DeleteFolderMembershipRequestRequestTypeDef#
# DeleteFolderMembershipRequestRequestTypeDef definition
class DeleteFolderMembershipRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
- See MemberTypeType
DeleteFolderRequestRequestTypeDef#
# DeleteFolderRequestRequestTypeDef definition
class DeleteFolderRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
DeleteGroupMembershipRequestRequestTypeDef#
# DeleteGroupMembershipRequestRequestTypeDef definition
class DeleteGroupMembershipRequestRequestTypeDef(TypedDict):
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
DeleteGroupRequestRequestTypeDef#
# DeleteGroupRequestRequestTypeDef definition
class DeleteGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
DeleteIAMPolicyAssignmentRequestRequestTypeDef#
# DeleteIAMPolicyAssignmentRequestRequestTypeDef definition
class DeleteIAMPolicyAssignmentRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
DeleteIdentityPropagationConfigRequestRequestTypeDef#
# DeleteIdentityPropagationConfigRequestRequestTypeDef definition
class DeleteIdentityPropagationConfigRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Service: ServiceTypeType, # (1)
- See ServiceTypeType
DeleteNamespaceRequestRequestTypeDef#
# DeleteNamespaceRequestRequestTypeDef definition
class DeleteNamespaceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
DeleteRefreshScheduleRequestRequestTypeDef#
# DeleteRefreshScheduleRequestRequestTypeDef definition
class DeleteRefreshScheduleRequestRequestTypeDef(TypedDict):
DataSetId: str,
AwsAccountId: str,
ScheduleId: str,
DeleteRoleCustomPermissionRequestRequestTypeDef#
# DeleteRoleCustomPermissionRequestRequestTypeDef definition
class DeleteRoleCustomPermissionRequestRequestTypeDef(TypedDict):
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
- See RoleType
DeleteRoleMembershipRequestRequestTypeDef#
# DeleteRoleMembershipRequestRequestTypeDef definition
class DeleteRoleMembershipRequestRequestTypeDef(TypedDict):
MemberName: str,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
- See RoleType
DeleteTemplateAliasRequestRequestTypeDef#
# DeleteTemplateAliasRequestRequestTypeDef definition
class DeleteTemplateAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
AliasName: str,
DeleteTemplateRequestRequestTypeDef#
# DeleteTemplateRequestRequestTypeDef definition
class DeleteTemplateRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
VersionNumber: NotRequired[int],
DeleteThemeAliasRequestRequestTypeDef#
# DeleteThemeAliasRequestRequestTypeDef definition
class DeleteThemeAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
AliasName: str,
DeleteThemeRequestRequestTypeDef#
# DeleteThemeRequestRequestTypeDef definition
class DeleteThemeRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
VersionNumber: NotRequired[int],
DeleteTopicRefreshScheduleRequestRequestTypeDef#
# DeleteTopicRefreshScheduleRequestRequestTypeDef definition
class DeleteTopicRefreshScheduleRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DatasetId: str,
DeleteTopicRequestRequestTypeDef#
# DeleteTopicRequestRequestTypeDef definition
class DeleteTopicRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DeleteUserByPrincipalIdRequestRequestTypeDef#
# DeleteUserByPrincipalIdRequestRequestTypeDef definition
class DeleteUserByPrincipalIdRequestRequestTypeDef(TypedDict):
PrincipalId: str,
AwsAccountId: str,
Namespace: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
UserName: str,
AwsAccountId: str,
Namespace: str,
DeleteVPCConnectionRequestRequestTypeDef#
# DeleteVPCConnectionRequestRequestTypeDef definition
class DeleteVPCConnectionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
VPCConnectionId: str,
DescribeAccountCustomizationRequestRequestTypeDef#
# DescribeAccountCustomizationRequestRequestTypeDef definition
class DescribeAccountCustomizationRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: NotRequired[str],
Resolved: NotRequired[bool],
DescribeAccountSettingsRequestRequestTypeDef#
# DescribeAccountSettingsRequestRequestTypeDef definition
class DescribeAccountSettingsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DescribeAccountSubscriptionRequestRequestTypeDef#
# DescribeAccountSubscriptionRequestRequestTypeDef definition
class DescribeAccountSubscriptionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DescribeAnalysisDefinitionRequestRequestTypeDef#
# DescribeAnalysisDefinitionRequestRequestTypeDef definition
class DescribeAnalysisDefinitionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
DescribeAnalysisPermissionsRequestRequestTypeDef#
# DescribeAnalysisPermissionsRequestRequestTypeDef definition
class DescribeAnalysisPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
DescribeAnalysisRequestRequestTypeDef#
# DescribeAnalysisRequestRequestTypeDef definition
class DescribeAnalysisRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
DescribeAssetBundleExportJobRequestRequestTypeDef#
# DescribeAssetBundleExportJobRequestRequestTypeDef definition
class DescribeAssetBundleExportJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssetBundleExportJobId: str,
DescribeAssetBundleImportJobRequestRequestTypeDef#
# DescribeAssetBundleImportJobRequestRequestTypeDef definition
class DescribeAssetBundleImportJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssetBundleImportJobId: str,
DescribeDashboardDefinitionRequestRequestTypeDef#
# DescribeDashboardDefinitionRequestRequestTypeDef definition
class DescribeDashboardDefinitionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
VersionNumber: NotRequired[int],
AliasName: NotRequired[str],
DescribeDashboardPermissionsRequestRequestTypeDef#
# DescribeDashboardPermissionsRequestRequestTypeDef definition
class DescribeDashboardPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
DescribeDashboardRequestRequestTypeDef#
# DescribeDashboardRequestRequestTypeDef definition
class DescribeDashboardRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
VersionNumber: NotRequired[int],
AliasName: NotRequired[str],
DescribeDashboardSnapshotJobRequestRequestTypeDef#
# DescribeDashboardSnapshotJobRequestRequestTypeDef definition
class DescribeDashboardSnapshotJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
DescribeDashboardSnapshotJobResultRequestRequestTypeDef#
# DescribeDashboardSnapshotJobResultRequestRequestTypeDef definition
class DescribeDashboardSnapshotJobResultRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
SnapshotJobErrorInfoTypeDef#
# SnapshotJobErrorInfoTypeDef definition
class SnapshotJobErrorInfoTypeDef(TypedDict):
ErrorMessage: NotRequired[str],
ErrorType: NotRequired[str],
DescribeDataSetPermissionsRequestRequestTypeDef#
# DescribeDataSetPermissionsRequestRequestTypeDef definition
class DescribeDataSetPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DescribeDataSetRefreshPropertiesRequestRequestTypeDef#
# DescribeDataSetRefreshPropertiesRequestRequestTypeDef definition
class DescribeDataSetRefreshPropertiesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DescribeDataSetRequestRequestTypeDef#
# DescribeDataSetRequestRequestTypeDef definition
class DescribeDataSetRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DescribeDataSourcePermissionsRequestRequestTypeDef#
# DescribeDataSourcePermissionsRequestRequestTypeDef definition
class DescribeDataSourcePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
DescribeDataSourceRequestRequestTypeDef#
# DescribeDataSourceRequestRequestTypeDef definition
class DescribeDataSourceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeFolderPermissionsRequestRequestTypeDef#
# DescribeFolderPermissionsRequestRequestTypeDef definition
class DescribeFolderPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Namespace: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ResourcePermissionPaginatorTypeDef#
# ResourcePermissionPaginatorTypeDef definition
class ResourcePermissionPaginatorTypeDef(TypedDict):
Principal: str,
Actions: List[str],
DescribeFolderRequestRequestTypeDef#
# DescribeFolderRequestRequestTypeDef definition
class DescribeFolderRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
DescribeFolderResolvedPermissionsRequestRequestTypeDef#
# DescribeFolderResolvedPermissionsRequestRequestTypeDef definition
class DescribeFolderResolvedPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Namespace: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
FolderTypeDef#
# FolderTypeDef definition
class FolderTypeDef(TypedDict):
FolderId: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
FolderType: NotRequired[FolderTypeType], # (1)
FolderPath: NotRequired[List[str]],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
SharingModel: NotRequired[SharingModelType], # (2)
- See FolderTypeType
- See SharingModelType
DescribeGroupMembershipRequestRequestTypeDef#
# DescribeGroupMembershipRequestRequestTypeDef definition
class DescribeGroupMembershipRequestRequestTypeDef(TypedDict):
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
DescribeGroupRequestRequestTypeDef#
# DescribeGroupRequestRequestTypeDef definition
class DescribeGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
DescribeIAMPolicyAssignmentRequestRequestTypeDef#
# DescribeIAMPolicyAssignmentRequestRequestTypeDef definition
class DescribeIAMPolicyAssignmentRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
IAMPolicyAssignmentTypeDef#
# IAMPolicyAssignmentTypeDef definition
class IAMPolicyAssignmentTypeDef(TypedDict):
AwsAccountId: NotRequired[str],
AssignmentId: NotRequired[str],
AssignmentName: NotRequired[str],
PolicyArn: NotRequired[str],
Identities: NotRequired[Dict[str, List[str]]],
AssignmentStatus: NotRequired[AssignmentStatusType], # (1)
DescribeIngestionRequestRequestTypeDef#
# DescribeIngestionRequestRequestTypeDef definition
class DescribeIngestionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
DescribeIpRestrictionRequestRequestTypeDef#
# DescribeIpRestrictionRequestRequestTypeDef definition
class DescribeIpRestrictionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DescribeNamespaceRequestRequestTypeDef#
# DescribeNamespaceRequestRequestTypeDef definition
class DescribeNamespaceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
DescribeRefreshScheduleRequestRequestTypeDef#
# DescribeRefreshScheduleRequestRequestTypeDef definition
class DescribeRefreshScheduleRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
ScheduleId: str,
DescribeRoleCustomPermissionRequestRequestTypeDef#
# DescribeRoleCustomPermissionRequestRequestTypeDef definition
class DescribeRoleCustomPermissionRequestRequestTypeDef(TypedDict):
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
- See RoleType
DescribeTemplateAliasRequestRequestTypeDef#
# DescribeTemplateAliasRequestRequestTypeDef definition
class DescribeTemplateAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
AliasName: str,
DescribeTemplateDefinitionRequestRequestTypeDef#
# DescribeTemplateDefinitionRequestRequestTypeDef definition
class DescribeTemplateDefinitionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
VersionNumber: NotRequired[int],
AliasName: NotRequired[str],
DescribeTemplatePermissionsRequestRequestTypeDef#
# DescribeTemplatePermissionsRequestRequestTypeDef definition
class DescribeTemplatePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
DescribeTemplateRequestRequestTypeDef#
# DescribeTemplateRequestRequestTypeDef definition
class DescribeTemplateRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
VersionNumber: NotRequired[int],
AliasName: NotRequired[str],
DescribeThemeAliasRequestRequestTypeDef#
# DescribeThemeAliasRequestRequestTypeDef definition
class DescribeThemeAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
AliasName: str,
DescribeThemePermissionsRequestRequestTypeDef#
# DescribeThemePermissionsRequestRequestTypeDef definition
class DescribeThemePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
DescribeThemeRequestRequestTypeDef#
# DescribeThemeRequestRequestTypeDef definition
class DescribeThemeRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
VersionNumber: NotRequired[int],
AliasName: NotRequired[str],
DescribeTopicPermissionsRequestRequestTypeDef#
# DescribeTopicPermissionsRequestRequestTypeDef definition
class DescribeTopicPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DescribeTopicRefreshRequestRequestTypeDef#
# DescribeTopicRefreshRequestRequestTypeDef definition
class DescribeTopicRefreshRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
RefreshId: str,
TopicRefreshDetailsTypeDef#
# TopicRefreshDetailsTypeDef definition
class TopicRefreshDetailsTypeDef(TypedDict):
RefreshArn: NotRequired[str],
RefreshId: NotRequired[str],
RefreshStatus: NotRequired[TopicRefreshStatusType], # (1)
DescribeTopicRefreshScheduleRequestRequestTypeDef#
# DescribeTopicRefreshScheduleRequestRequestTypeDef definition
class DescribeTopicRefreshScheduleRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DatasetId: str,
DescribeTopicRequestRequestTypeDef#
# DescribeTopicRequestRequestTypeDef definition
class DescribeTopicRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DescribeUserRequestRequestTypeDef#
# DescribeUserRequestRequestTypeDef definition
class DescribeUserRequestRequestTypeDef(TypedDict):
UserName: str,
AwsAccountId: str,
Namespace: str,
UserTypeDef#
# UserTypeDef definition
class UserTypeDef(TypedDict):
Arn: NotRequired[str],
UserName: NotRequired[str],
Email: NotRequired[str],
Role: NotRequired[UserRoleType], # (1)
IdentityType: NotRequired[IdentityTypeType], # (2)
Active: NotRequired[bool],
PrincipalId: NotRequired[str],
CustomPermissionsName: NotRequired[str],
ExternalLoginFederationProviderType: NotRequired[str],
ExternalLoginFederationProviderUrl: NotRequired[str],
ExternalLoginId: NotRequired[str],
- See UserRoleType
- See IdentityTypeType
DescribeVPCConnectionRequestRequestTypeDef#
# DescribeVPCConnectionRequestRequestTypeDef definition
class DescribeVPCConnectionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
VPCConnectionId: str,
NegativeFormatTypeDef#
# NegativeFormatTypeDef definition
class NegativeFormatTypeDef(TypedDict):
Prefix: NotRequired[str],
Suffix: NotRequired[str],
DonutCenterOptionsTypeDef#
# DonutCenterOptionsTypeDef definition
class DonutCenterOptionsTypeDef(TypedDict):
LabelVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
ListControlSelectAllOptionsTypeDef#
# ListControlSelectAllOptionsTypeDef definition
class ListControlSelectAllOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
ErrorInfoTypeDef#
# ErrorInfoTypeDef definition
class ErrorInfoTypeDef(TypedDict):
Type: NotRequired[IngestionErrorTypeType], # (1)
Message: NotRequired[str],
ExcludePeriodConfigurationTypeDef#
# ExcludePeriodConfigurationTypeDef definition
class ExcludePeriodConfigurationTypeDef(TypedDict):
Amount: int,
Granularity: TimeGranularityType, # (1)
Status: NotRequired[WidgetStatusType], # (2)
- See TimeGranularityType
- See WidgetStatusType
FieldSortTypeDef#
# FieldSortTypeDef definition
class FieldSortTypeDef(TypedDict):
FieldId: str,
Direction: SortDirectionType, # (1)
FieldTooltipItemTypeDef#
# FieldTooltipItemTypeDef definition
class FieldTooltipItemTypeDef(TypedDict):
FieldId: str,
Label: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (1)
TooltipTarget: NotRequired[TooltipTargetType], # (2)
- See VisibilityType
- See TooltipTargetType
GeospatialMapStyleOptionsTypeDef#
# GeospatialMapStyleOptionsTypeDef definition
class GeospatialMapStyleOptionsTypeDef(TypedDict):
BaseMapStyle: NotRequired[BaseMapStyleTypeType], # (1)
FilterSelectableValuesTypeDef#
# FilterSelectableValuesTypeDef definition
class FilterSelectableValuesTypeDef(TypedDict):
Values: NotRequired[Sequence[str]],
SameSheetTargetVisualConfigurationTypeDef#
# SameSheetTargetVisualConfigurationTypeDef definition
class SameSheetTargetVisualConfigurationTypeDef(TypedDict):
TargetVisuals: NotRequired[Sequence[str]],
TargetVisualOptions: NotRequired[TargetVisualOptionsType], # (1)
FilterOperationTypeDef#
# FilterOperationTypeDef definition
class FilterOperationTypeDef(TypedDict):
ConditionExpression: str,
FolderSearchFilterTypeDef#
# FolderSearchFilterTypeDef definition
class FolderSearchFilterTypeDef(TypedDict):
Operator: NotRequired[FilterOperatorType], # (1)
Name: NotRequired[FolderFilterAttributeType], # (2)
Value: NotRequired[str],
FolderSummaryTypeDef#
# FolderSummaryTypeDef definition
class FolderSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
FolderId: NotRequired[str],
Name: NotRequired[str],
FolderType: NotRequired[FolderTypeType], # (1)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
SharingModel: NotRequired[SharingModelType], # (2)
- See FolderTypeType
- See SharingModelType
FontSizeTypeDef#
# FontSizeTypeDef definition
class FontSizeTypeDef(TypedDict):
Relative: NotRequired[RelativeFontSizeType], # (1)
FontWeightTypeDef#
# FontWeightTypeDef definition
class FontWeightTypeDef(TypedDict):
Name: NotRequired[FontWeightNameType], # (1)
FontTypeDef#
# FontTypeDef definition
class FontTypeDef(TypedDict):
FontFamily: NotRequired[str],
TimeBasedForecastPropertiesTypeDef#
# TimeBasedForecastPropertiesTypeDef definition
class TimeBasedForecastPropertiesTypeDef(TypedDict):
PeriodsForward: NotRequired[int],
PeriodsBackward: NotRequired[int],
UpperBoundary: NotRequired[float],
LowerBoundary: NotRequired[float],
PredictionInterval: NotRequired[int],
Seasonality: NotRequired[int],
FreeFormLayoutScreenCanvasSizeOptionsTypeDef#
# FreeFormLayoutScreenCanvasSizeOptionsTypeDef definition
class FreeFormLayoutScreenCanvasSizeOptionsTypeDef(TypedDict):
OptimizedViewPortWidth: str,
FreeFormLayoutElementBackgroundStyleTypeDef#
# FreeFormLayoutElementBackgroundStyleTypeDef definition
class FreeFormLayoutElementBackgroundStyleTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
Color: NotRequired[str],
- See VisibilityType
FreeFormLayoutElementBorderStyleTypeDef#
# FreeFormLayoutElementBorderStyleTypeDef definition
class FreeFormLayoutElementBorderStyleTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
Color: NotRequired[str],
- See VisibilityType
LoadingAnimationTypeDef#
# LoadingAnimationTypeDef definition
class LoadingAnimationTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
SessionTagTypeDef#
# SessionTagTypeDef definition
class SessionTagTypeDef(TypedDict):
Key: str,
Value: str,
GeospatialCoordinateBoundsTypeDef#
# GeospatialCoordinateBoundsTypeDef definition
class GeospatialCoordinateBoundsTypeDef(TypedDict):
North: float,
South: float,
West: float,
East: float,
GeospatialHeatmapDataColorTypeDef#
# GeospatialHeatmapDataColorTypeDef definition
class GeospatialHeatmapDataColorTypeDef(TypedDict):
Color: str,
GetDashboardEmbedUrlRequestRequestTypeDef#
# GetDashboardEmbedUrlRequestRequestTypeDef definition
class GetDashboardEmbedUrlRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
IdentityType: EmbeddingIdentityTypeType, # (1)
SessionLifetimeInMinutes: NotRequired[int],
UndoRedoDisabled: NotRequired[bool],
ResetDisabled: NotRequired[bool],
StatePersistenceEnabled: NotRequired[bool],
UserArn: NotRequired[str],
Namespace: NotRequired[str],
AdditionalDashboardIds: NotRequired[Sequence[str]],
GetSessionEmbedUrlRequestRequestTypeDef#
# GetSessionEmbedUrlRequestRequestTypeDef definition
class GetSessionEmbedUrlRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
EntryPoint: NotRequired[str],
SessionLifetimeInMinutes: NotRequired[int],
UserArn: NotRequired[str],
TableBorderOptionsTypeDef#
# TableBorderOptionsTypeDef definition
class TableBorderOptionsTypeDef(TypedDict):
Color: NotRequired[str],
Thickness: NotRequired[int],
Style: NotRequired[TableBorderStyleType], # (1)
GradientStopTypeDef#
# GradientStopTypeDef definition
class GradientStopTypeDef(TypedDict):
GradientOffset: float,
DataValue: NotRequired[float],
Color: NotRequired[str],
GridLayoutScreenCanvasSizeOptionsTypeDef#
# GridLayoutScreenCanvasSizeOptionsTypeDef definition
class GridLayoutScreenCanvasSizeOptionsTypeDef(TypedDict):
ResizeOption: ResizeOptionType, # (1)
OptimizedViewPortWidth: NotRequired[str],
- See ResizeOptionType
GridLayoutElementTypeDef#
# GridLayoutElementTypeDef definition
class GridLayoutElementTypeDef(TypedDict):
ElementId: str,
ElementType: LayoutElementTypeType, # (1)
ColumnSpan: int,
RowSpan: int,
ColumnIndex: NotRequired[int],
RowIndex: NotRequired[int],
GroupSearchFilterTypeDef#
# GroupSearchFilterTypeDef definition
class GroupSearchFilterTypeDef(TypedDict):
Operator: GroupFilterOperatorType, # (1)
Name: GroupFilterAttributeType, # (2)
Value: str,
GutterStyleTypeDef#
# GutterStyleTypeDef definition
class GutterStyleTypeDef(TypedDict):
Show: NotRequired[bool],
IAMPolicyAssignmentSummaryTypeDef#
# IAMPolicyAssignmentSummaryTypeDef definition
class IAMPolicyAssignmentSummaryTypeDef(TypedDict):
AssignmentName: NotRequired[str],
AssignmentStatus: NotRequired[AssignmentStatusType], # (1)
IdentityCenterConfigurationTypeDef#
# IdentityCenterConfigurationTypeDef definition
class IdentityCenterConfigurationTypeDef(TypedDict):
EnableIdentityPropagation: NotRequired[bool],
LookbackWindowTypeDef#
# LookbackWindowTypeDef definition
class LookbackWindowTypeDef(TypedDict):
ColumnName: str,
Size: int,
SizeUnit: LookbackWindowSizeUnitType, # (1)
QueueInfoTypeDef#
# QueueInfoTypeDef definition
class QueueInfoTypeDef(TypedDict):
WaitingOnIngestion: str,
QueuedIngestion: str,
RowInfoTypeDef#
# RowInfoTypeDef definition
class RowInfoTypeDef(TypedDict):
RowsIngested: NotRequired[int],
RowsDropped: NotRequired[int],
TotalRowsInDataset: NotRequired[int],
IntegerDatasetParameterDefaultValuesTypeDef#
# IntegerDatasetParameterDefaultValuesTypeDef definition
class IntegerDatasetParameterDefaultValuesTypeDef(TypedDict):
StaticValues: NotRequired[Sequence[int]],
IntegerValueWhenUnsetConfigurationTypeDef#
# IntegerValueWhenUnsetConfigurationTypeDef definition
class IntegerValueWhenUnsetConfigurationTypeDef(TypedDict):
ValueWhenUnsetOption: NotRequired[ValueWhenUnsetOptionType], # (1)
CustomValue: NotRequired[int],
IntegerParameterTypeDef#
# IntegerParameterTypeDef definition
class IntegerParameterTypeDef(TypedDict):
Name: str,
Values: Sequence[int],
JoinKeyPropertiesTypeDef#
# JoinKeyPropertiesTypeDef definition
class JoinKeyPropertiesTypeDef(TypedDict):
UniqueKey: NotRequired[bool],
KPISparklineOptionsTypeDef#
# KPISparklineOptionsTypeDef definition
class KPISparklineOptionsTypeDef(TypedDict):
Type: KPISparklineTypeType, # (2)
Visibility: NotRequired[VisibilityType], # (1)
Color: NotRequired[str],
TooltipVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
- See KPISparklineTypeType
- See VisibilityType
ProgressBarOptionsTypeDef#
# ProgressBarOptionsTypeDef definition
class ProgressBarOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
SecondaryValueOptionsTypeDef#
# SecondaryValueOptionsTypeDef definition
class SecondaryValueOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
TrendArrowOptionsTypeDef#
# TrendArrowOptionsTypeDef definition
class TrendArrowOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
KPIVisualStandardLayoutTypeDef#
# KPIVisualStandardLayoutTypeDef definition
class KPIVisualStandardLayoutTypeDef(TypedDict):
Type: KPIVisualStandardLayoutTypeType, # (1)
LineChartLineStyleSettingsTypeDef#
# LineChartLineStyleSettingsTypeDef definition
class LineChartLineStyleSettingsTypeDef(TypedDict):
LineVisibility: NotRequired[VisibilityType], # (1)
LineInterpolation: NotRequired[LineInterpolationType], # (2)
LineStyle: NotRequired[LineChartLineStyleType], # (3)
LineWidth: NotRequired[str],
LineChartMarkerStyleSettingsTypeDef#
# LineChartMarkerStyleSettingsTypeDef definition
class LineChartMarkerStyleSettingsTypeDef(TypedDict):
MarkerVisibility: NotRequired[VisibilityType], # (1)
MarkerShape: NotRequired[LineChartMarkerShapeType], # (2)
MarkerSize: NotRequired[str],
MarkerColor: NotRequired[str],
MissingDataConfigurationTypeDef#
# MissingDataConfigurationTypeDef definition
class MissingDataConfigurationTypeDef(TypedDict):
TreatmentOption: NotRequired[MissingDataTreatmentOptionType], # (1)
ListAnalysesRequestRequestTypeDef#
# ListAnalysesRequestRequestTypeDef definition
class ListAnalysesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAssetBundleExportJobsRequestRequestTypeDef#
# ListAssetBundleExportJobsRequestRequestTypeDef definition
class ListAssetBundleExportJobsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAssetBundleImportJobsRequestRequestTypeDef#
# ListAssetBundleImportJobsRequestRequestTypeDef definition
class ListAssetBundleImportJobsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListControlSearchOptionsTypeDef#
# ListControlSearchOptionsTypeDef definition
class ListControlSearchOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
ListDashboardVersionsRequestRequestTypeDef#
# ListDashboardVersionsRequestRequestTypeDef definition
class ListDashboardVersionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDashboardsRequestRequestTypeDef#
# ListDashboardsRequestRequestTypeDef definition
class ListDashboardsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDataSetsRequestRequestTypeDef#
# ListDataSetsRequestRequestTypeDef definition
class ListDataSetsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDataSourcesRequestRequestTypeDef#
# ListDataSourcesRequestRequestTypeDef definition
class ListDataSourcesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListFolderMembersRequestRequestTypeDef#
# ListFolderMembersRequestRequestTypeDef definition
class ListFolderMembersRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MemberIdArnPairTypeDef#
# MemberIdArnPairTypeDef definition
class MemberIdArnPairTypeDef(TypedDict):
MemberId: NotRequired[str],
MemberArn: NotRequired[str],
ListFoldersRequestRequestTypeDef#
# ListFoldersRequestRequestTypeDef definition
class ListFoldersRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListGroupMembershipsRequestRequestTypeDef#
# ListGroupMembershipsRequestRequestTypeDef definition
class ListGroupMembershipsRequestRequestTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListGroupsRequestRequestTypeDef#
# ListGroupsRequestRequestTypeDef definition
class ListGroupsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIAMPolicyAssignmentsForUserRequestRequestTypeDef#
# ListIAMPolicyAssignmentsForUserRequestRequestTypeDef definition
class ListIAMPolicyAssignmentsForUserRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
UserName: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIAMPolicyAssignmentsRequestRequestTypeDef#
# ListIAMPolicyAssignmentsRequestRequestTypeDef definition
class ListIAMPolicyAssignmentsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
AssignmentStatus: NotRequired[AssignmentStatusType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListIdentityPropagationConfigsRequestRequestTypeDef#
# ListIdentityPropagationConfigsRequestRequestTypeDef definition
class ListIdentityPropagationConfigsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListIngestionsRequestRequestTypeDef#
# ListIngestionsRequestRequestTypeDef definition
class ListIngestionsRequestRequestTypeDef(TypedDict):
DataSetId: str,
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListNamespacesRequestRequestTypeDef#
# ListNamespacesRequestRequestTypeDef definition
class ListNamespacesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListRefreshSchedulesRequestRequestTypeDef#
# ListRefreshSchedulesRequestRequestTypeDef definition
class ListRefreshSchedulesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
ListRoleMembershipsRequestRequestTypeDef#
# ListRoleMembershipsRequestRequestTypeDef definition
class ListRoleMembershipsRequestRequestTypeDef(TypedDict):
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See RoleType
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
ListTemplateAliasesRequestRequestTypeDef#
# ListTemplateAliasesRequestRequestTypeDef definition
class ListTemplateAliasesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTemplateVersionsRequestRequestTypeDef#
# ListTemplateVersionsRequestRequestTypeDef definition
class ListTemplateVersionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
TemplateVersionSummaryTypeDef#
# TemplateVersionSummaryTypeDef definition
class TemplateVersionSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
VersionNumber: NotRequired[int],
CreatedTime: NotRequired[datetime],
Status: NotRequired[ResourceStatusType], # (1)
Description: NotRequired[str],
ListTemplatesRequestRequestTypeDef#
# ListTemplatesRequestRequestTypeDef definition
class ListTemplatesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
TemplateSummaryTypeDef#
# TemplateSummaryTypeDef definition
class TemplateSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
TemplateId: NotRequired[str],
Name: NotRequired[str],
LatestVersionNumber: NotRequired[int],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ListThemeAliasesRequestRequestTypeDef#
# ListThemeAliasesRequestRequestTypeDef definition
class ListThemeAliasesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListThemeVersionsRequestRequestTypeDef#
# ListThemeVersionsRequestRequestTypeDef definition
class ListThemeVersionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ThemeVersionSummaryTypeDef#
# ThemeVersionSummaryTypeDef definition
class ThemeVersionSummaryTypeDef(TypedDict):
VersionNumber: NotRequired[int],
Arn: NotRequired[str],
Description: NotRequired[str],
CreatedTime: NotRequired[datetime],
Status: NotRequired[ResourceStatusType], # (1)
ListThemesRequestRequestTypeDef#
# ListThemesRequestRequestTypeDef definition
class ListThemesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Type: NotRequired[ThemeTypeType], # (1)
- See ThemeTypeType
ThemeSummaryTypeDef#
# ThemeSummaryTypeDef definition
class ThemeSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
Name: NotRequired[str],
ThemeId: NotRequired[str],
LatestVersionNumber: NotRequired[int],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ListTopicRefreshSchedulesRequestRequestTypeDef#
# ListTopicRefreshSchedulesRequestRequestTypeDef definition
class ListTopicRefreshSchedulesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
ListTopicsRequestRequestTypeDef#
# ListTopicsRequestRequestTypeDef definition
class ListTopicsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
TopicSummaryTypeDef#
# TopicSummaryTypeDef definition
class TopicSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
TopicId: NotRequired[str],
Name: NotRequired[str],
ListUserGroupsRequestRequestTypeDef#
# ListUserGroupsRequestRequestTypeDef definition
class ListUserGroupsRequestRequestTypeDef(TypedDict):
UserName: str,
AwsAccountId: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListUsersRequestRequestTypeDef#
# ListUsersRequestRequestTypeDef definition
class ListUsersRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListVPCConnectionsRequestRequestTypeDef#
# ListVPCConnectionsRequestRequestTypeDef definition
class ListVPCConnectionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
LongFormatTextTypeDef#
# LongFormatTextTypeDef definition
class LongFormatTextTypeDef(TypedDict):
PlainText: NotRequired[str],
RichText: NotRequired[str],
ManifestFileLocationTypeDef#
# ManifestFileLocationTypeDef definition
class ManifestFileLocationTypeDef(TypedDict):
Bucket: str,
Key: str,
MarginStyleTypeDef#
# MarginStyleTypeDef definition
class MarginStyleTypeDef(TypedDict):
Show: NotRequired[bool],
NamedEntityDefinitionMetricTypeDef#
# NamedEntityDefinitionMetricTypeDef definition
class NamedEntityDefinitionMetricTypeDef(TypedDict):
Aggregation: NotRequired[NamedEntityAggTypeType], # (1)
AggregationFunctionParameters: NotRequired[Mapping[str, str]],
NamespaceErrorTypeDef#
# NamespaceErrorTypeDef definition
class NamespaceErrorTypeDef(TypedDict):
Type: NotRequired[NamespaceErrorTypeType], # (1)
Message: NotRequired[str],
NetworkInterfaceTypeDef#
# NetworkInterfaceTypeDef definition
class NetworkInterfaceTypeDef(TypedDict):
SubnetId: NotRequired[str],
AvailabilityZone: NotRequired[str],
ErrorMessage: NotRequired[str],
Status: NotRequired[NetworkInterfaceStatusType], # (1)
NetworkInterfaceId: NotRequired[str],
NumericRangeFilterValueTypeDef#
# NumericRangeFilterValueTypeDef definition
class NumericRangeFilterValueTypeDef(TypedDict):
StaticValue: NotRequired[float],
Parameter: NotRequired[str],
ThousandSeparatorOptionsTypeDef#
# ThousandSeparatorOptionsTypeDef definition
class ThousandSeparatorOptionsTypeDef(TypedDict):
Symbol: NotRequired[NumericSeparatorSymbolType], # (1)
Visibility: NotRequired[VisibilityType], # (2)
PercentileAggregationTypeDef#
# PercentileAggregationTypeDef definition
class PercentileAggregationTypeDef(TypedDict):
PercentileValue: NotRequired[float],
StringParameterTypeDef#
# StringParameterTypeDef definition
class StringParameterTypeDef(TypedDict):
Name: str,
Values: Sequence[str],
PercentVisibleRangeTypeDef#
# PercentVisibleRangeTypeDef definition
class PercentVisibleRangeTypeDef(TypedDict):
From: NotRequired[float],
To: NotRequired[float],
PivotTableConditionalFormattingScopeTypeDef#
# PivotTableConditionalFormattingScopeTypeDef definition
class PivotTableConditionalFormattingScopeTypeDef(TypedDict):
Role: NotRequired[PivotTableConditionalFormattingScopeRoleType], # (1)
PivotTablePaginatedReportOptionsTypeDef#
# PivotTablePaginatedReportOptionsTypeDef definition
class PivotTablePaginatedReportOptionsTypeDef(TypedDict):
VerticalOverflowVisibility: NotRequired[VisibilityType], # (1)
OverflowColumnHeaderVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
- See VisibilityType
PivotTableFieldOptionTypeDef#
# PivotTableFieldOptionTypeDef definition
class PivotTableFieldOptionTypeDef(TypedDict):
FieldId: str,
CustomLabel: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
PivotTableFieldSubtotalOptionsTypeDef#
# PivotTableFieldSubtotalOptionsTypeDef definition
class PivotTableFieldSubtotalOptionsTypeDef(TypedDict):
FieldId: NotRequired[str],
PivotTableRowsLabelOptionsTypeDef#
# PivotTableRowsLabelOptionsTypeDef definition
class PivotTableRowsLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
CustomLabel: NotRequired[str],
- See VisibilityType
RowAlternateColorOptionsTypeDef#
# RowAlternateColorOptionsTypeDef definition
class RowAlternateColorOptionsTypeDef(TypedDict):
Status: NotRequired[WidgetStatusType], # (1)
RowAlternateColors: NotRequired[Sequence[str]],
UsePrimaryBackgroundColor: NotRequired[WidgetStatusType], # (1)
- See WidgetStatusType
- See WidgetStatusType
ProjectOperationTypeDef#
# ProjectOperationTypeDef definition
class ProjectOperationTypeDef(TypedDict):
ProjectedColumns: Sequence[str],
RadarChartAreaStyleSettingsTypeDef#
# RadarChartAreaStyleSettingsTypeDef definition
class RadarChartAreaStyleSettingsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
RangeConstantTypeDef#
# RangeConstantTypeDef definition
class RangeConstantTypeDef(TypedDict):
Minimum: NotRequired[str],
Maximum: NotRequired[str],
RedshiftIAMParametersPaginatorTypeDef#
# RedshiftIAMParametersPaginatorTypeDef definition
class RedshiftIAMParametersPaginatorTypeDef(TypedDict):
RoleArn: str,
DatabaseUser: str,
DatabaseGroups: NotRequired[List[str]],
AutoCreateDatabaseUser: NotRequired[bool],
RedshiftIAMParametersTypeDef#
# RedshiftIAMParametersTypeDef definition
class RedshiftIAMParametersTypeDef(TypedDict):
RoleArn: str,
DatabaseUser: str,
DatabaseGroups: NotRequired[Sequence[str]],
AutoCreateDatabaseUser: NotRequired[bool],
ReferenceLineCustomLabelConfigurationTypeDef#
# ReferenceLineCustomLabelConfigurationTypeDef definition
class ReferenceLineCustomLabelConfigurationTypeDef(TypedDict):
CustomLabel: str,
ReferenceLineStaticDataConfigurationTypeDef#
# ReferenceLineStaticDataConfigurationTypeDef definition
class ReferenceLineStaticDataConfigurationTypeDef(TypedDict):
Value: float,
ReferenceLineStyleConfigurationTypeDef#
# ReferenceLineStyleConfigurationTypeDef definition
class ReferenceLineStyleConfigurationTypeDef(TypedDict):
Pattern: NotRequired[ReferenceLinePatternTypeType], # (1)
Color: NotRequired[str],
ScheduleRefreshOnEntityTypeDef#
# ScheduleRefreshOnEntityTypeDef definition
class ScheduleRefreshOnEntityTypeDef(TypedDict):
DayOfWeek: NotRequired[DayOfWeekType], # (1)
DayOfMonth: NotRequired[str],
- See DayOfWeekType
StatePersistenceConfigurationsTypeDef#
# StatePersistenceConfigurationsTypeDef definition
class StatePersistenceConfigurationsTypeDef(TypedDict):
Enabled: bool,
RegisteredUserQSearchBarEmbeddingConfigurationTypeDef#
# RegisteredUserQSearchBarEmbeddingConfigurationTypeDef definition
class RegisteredUserQSearchBarEmbeddingConfigurationTypeDef(TypedDict):
InitialTopicId: NotRequired[str],
RenameColumnOperationTypeDef#
# RenameColumnOperationTypeDef definition
class RenameColumnOperationTypeDef(TypedDict):
ColumnName: str,
NewColumnName: str,
RestoreAnalysisRequestRequestTypeDef#
# RestoreAnalysisRequestRequestTypeDef definition
class RestoreAnalysisRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
RowLevelPermissionTagRuleTypeDef#
# RowLevelPermissionTagRuleTypeDef definition
class RowLevelPermissionTagRuleTypeDef(TypedDict):
TagKey: str,
ColumnName: str,
TagMultiValueDelimiter: NotRequired[str],
MatchAllValue: NotRequired[str],
S3BucketConfigurationTypeDef#
# S3BucketConfigurationTypeDef definition
class S3BucketConfigurationTypeDef(TypedDict):
BucketName: str,
BucketPrefix: str,
BucketRegion: str,
UploadSettingsTypeDef#
# UploadSettingsTypeDef definition
class UploadSettingsTypeDef(TypedDict):
Format: NotRequired[FileFormatType], # (1)
StartFromRow: NotRequired[int],
ContainsHeader: NotRequired[bool],
TextQualifier: NotRequired[TextQualifierType], # (2)
Delimiter: NotRequired[str],
- See FileFormatType
- See TextQualifierType
SectionAfterPageBreakTypeDef#
# SectionAfterPageBreakTypeDef definition
class SectionAfterPageBreakTypeDef(TypedDict):
Status: NotRequired[SectionPageBreakStatusType], # (1)
SpacingTypeDef#
# SpacingTypeDef definition
class SpacingTypeDef(TypedDict):
Top: NotRequired[str],
Bottom: NotRequired[str],
Left: NotRequired[str],
Right: NotRequired[str],
SheetVisualScopingConfigurationTypeDef#
# SheetVisualScopingConfigurationTypeDef definition
class SheetVisualScopingConfigurationTypeDef(TypedDict):
SheetId: str,
Scope: FilterVisualScopeType, # (1)
VisualIds: NotRequired[Sequence[str]],
SemanticEntityTypeTypeDef#
# SemanticEntityTypeTypeDef definition
class SemanticEntityTypeTypeDef(TypedDict):
TypeName: NotRequired[str],
SubTypeName: NotRequired[str],
TypeParameters: NotRequired[Mapping[str, str]],
SemanticTypeTypeDef#
# SemanticTypeTypeDef definition
class SemanticTypeTypeDef(TypedDict):
TypeName: NotRequired[str],
SubTypeName: NotRequired[str],
TypeParameters: NotRequired[Mapping[str, str]],
TruthyCellValue: NotRequired[str],
TruthyCellValueSynonyms: NotRequired[Sequence[str]],
FalseyCellValue: NotRequired[str],
FalseyCellValueSynonyms: NotRequired[Sequence[str]],
SheetTextBoxTypeDef#
# SheetTextBoxTypeDef definition
class SheetTextBoxTypeDef(TypedDict):
SheetTextBoxId: str,
Content: NotRequired[str],
SheetElementConfigurationOverridesTypeDef#
# SheetElementConfigurationOverridesTypeDef definition
class SheetElementConfigurationOverridesTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
ShortFormatTextTypeDef#
# ShortFormatTextTypeDef definition
class ShortFormatTextTypeDef(TypedDict):
PlainText: NotRequired[str],
RichText: NotRequired[str],
YAxisOptionsTypeDef#
# YAxisOptionsTypeDef definition
class YAxisOptionsTypeDef(TypedDict):
YAxis: SingleYAxisOptionType, # (1)
SmallMultiplesAxisPropertiesTypeDef#
# SmallMultiplesAxisPropertiesTypeDef definition
class SmallMultiplesAxisPropertiesTypeDef(TypedDict):
Scale: NotRequired[SmallMultiplesAxisScaleType], # (1)
Placement: NotRequired[SmallMultiplesAxisPlacementType], # (2)
SnapshotAnonymousUserRedactedTypeDef#
# SnapshotAnonymousUserRedactedTypeDef definition
class SnapshotAnonymousUserRedactedTypeDef(TypedDict):
RowLevelPermissionTagKeys: NotRequired[List[str]],
SnapshotFileSheetSelectionTypeDef#
# SnapshotFileSheetSelectionTypeDef definition
class SnapshotFileSheetSelectionTypeDef(TypedDict):
SheetId: str,
SelectionScope: SnapshotFileSheetSelectionScopeType, # (1)
VisualIds: NotRequired[List[str]],
SnapshotJobResultErrorInfoTypeDef#
# SnapshotJobResultErrorInfoTypeDef definition
class SnapshotJobResultErrorInfoTypeDef(TypedDict):
ErrorMessage: NotRequired[str],
ErrorType: NotRequired[str],
StringDatasetParameterDefaultValuesTypeDef#
# StringDatasetParameterDefaultValuesTypeDef definition
class StringDatasetParameterDefaultValuesTypeDef(TypedDict):
StaticValues: NotRequired[Sequence[str]],
StringValueWhenUnsetConfigurationTypeDef#
# StringValueWhenUnsetConfigurationTypeDef definition
class StringValueWhenUnsetConfigurationTypeDef(TypedDict):
ValueWhenUnsetOption: NotRequired[ValueWhenUnsetOptionType], # (1)
CustomValue: NotRequired[str],
TableStyleTargetTypeDef#
# TableStyleTargetTypeDef definition
class TableStyleTargetTypeDef(TypedDict):
CellType: StyledCellTypeType, # (1)
TableCellImageSizingConfigurationTypeDef#
# TableCellImageSizingConfigurationTypeDef definition
class TableCellImageSizingConfigurationTypeDef(TypedDict):
TableCellImageScalingConfiguration: NotRequired[TableCellImageScalingConfigurationType], # (1)
TablePaginatedReportOptionsTypeDef#
# TablePaginatedReportOptionsTypeDef definition
class TablePaginatedReportOptionsTypeDef(TypedDict):
VerticalOverflowVisibility: NotRequired[VisibilityType], # (1)
OverflowColumnHeaderVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
- See VisibilityType
TableFieldCustomIconContentTypeDef#
# TableFieldCustomIconContentTypeDef definition
class TableFieldCustomIconContentTypeDef(TypedDict):
Icon: NotRequired[TableFieldIconSetTypeType], # (1)
TablePinnedFieldOptionsTypeDef#
# TablePinnedFieldOptionsTypeDef definition
class TablePinnedFieldOptionsTypeDef(TypedDict):
PinnedLeftFields: NotRequired[Sequence[str]],
TemplateSourceTemplateTypeDef#
# TemplateSourceTemplateTypeDef definition
class TemplateSourceTemplateTypeDef(TypedDict):
Arn: str,
TextControlPlaceholderOptionsTypeDef#
# TextControlPlaceholderOptionsTypeDef definition
class TextControlPlaceholderOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
UIColorPaletteTypeDef#
# UIColorPaletteTypeDef definition
class UIColorPaletteTypeDef(TypedDict):
PrimaryForeground: NotRequired[str],
PrimaryBackground: NotRequired[str],
SecondaryForeground: NotRequired[str],
SecondaryBackground: NotRequired[str],
Accent: NotRequired[str],
AccentForeground: NotRequired[str],
Danger: NotRequired[str],
DangerForeground: NotRequired[str],
Warning: NotRequired[str],
WarningForeground: NotRequired[str],
Success: NotRequired[str],
SuccessForeground: NotRequired[str],
Dimension: NotRequired[str],
DimensionForeground: NotRequired[str],
Measure: NotRequired[str],
MeasureForeground: NotRequired[str],
ThemeErrorTypeDef#
# ThemeErrorTypeDef definition
class ThemeErrorTypeDef(TypedDict):
Type: NotRequired[ThemeErrorTypeType], # (1)
Message: NotRequired[str],
TopicSingularFilterConstantTypeDef#
# TopicSingularFilterConstantTypeDef definition
class TopicSingularFilterConstantTypeDef(TypedDict):
ConstantType: NotRequired[ConstantTypeType], # (1)
SingularConstant: NotRequired[str],
- See ConstantTypeType
TotalAggregationFunctionTypeDef#
# TotalAggregationFunctionTypeDef definition
class TotalAggregationFunctionTypeDef(TypedDict):
SimpleTotalAggregationFunction: NotRequired[SimpleTotalAggregationFunctionType], # (1)
UntagColumnOperationTypeDef#
# UntagColumnOperationTypeDef definition
class UntagColumnOperationTypeDef(TypedDict):
ColumnName: str,
TagNames: Sequence[ColumnTagNameType], # (1)
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
UpdateAccountSettingsRequestRequestTypeDef#
# UpdateAccountSettingsRequestRequestTypeDef definition
class UpdateAccountSettingsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DefaultNamespace: str,
NotificationEmail: NotRequired[str],
TerminationProtectionEnabled: NotRequired[bool],
UpdateDashboardLinksRequestRequestTypeDef#
# UpdateDashboardLinksRequestRequestTypeDef definition
class UpdateDashboardLinksRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
LinkEntities: Sequence[str],
UpdateDashboardPublishedVersionRequestRequestTypeDef#
# UpdateDashboardPublishedVersionRequestRequestTypeDef definition
class UpdateDashboardPublishedVersionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
VersionNumber: int,
UpdateFolderRequestRequestTypeDef#
# UpdateFolderRequestRequestTypeDef definition
class UpdateFolderRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Name: str,
UpdateGroupRequestRequestTypeDef#
# UpdateGroupRequestRequestTypeDef definition
class UpdateGroupRequestRequestTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: NotRequired[str],
UpdateIAMPolicyAssignmentRequestRequestTypeDef#
# UpdateIAMPolicyAssignmentRequestRequestTypeDef definition
class UpdateIAMPolicyAssignmentRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
AssignmentStatus: NotRequired[AssignmentStatusType], # (1)
PolicyArn: NotRequired[str],
Identities: NotRequired[Mapping[str, Sequence[str]]],
UpdateIdentityPropagationConfigRequestRequestTypeDef#
# UpdateIdentityPropagationConfigRequestRequestTypeDef definition
class UpdateIdentityPropagationConfigRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Service: ServiceTypeType, # (1)
AuthorizedTargets: NotRequired[Sequence[str]],
- See ServiceTypeType
UpdateIpRestrictionRequestRequestTypeDef#
# UpdateIpRestrictionRequestRequestTypeDef definition
class UpdateIpRestrictionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
IpRestrictionRuleMap: NotRequired[Mapping[str, str]],
Enabled: NotRequired[bool],
UpdatePublicSharingSettingsRequestRequestTypeDef#
# UpdatePublicSharingSettingsRequestRequestTypeDef definition
class UpdatePublicSharingSettingsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
PublicSharingEnabled: NotRequired[bool],
UpdateRoleCustomPermissionRequestRequestTypeDef#
# UpdateRoleCustomPermissionRequestRequestTypeDef definition
class UpdateRoleCustomPermissionRequestRequestTypeDef(TypedDict):
CustomPermissionsName: str,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
- See RoleType
UpdateTemplateAliasRequestRequestTypeDef#
# UpdateTemplateAliasRequestRequestTypeDef definition
class UpdateTemplateAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
UpdateThemeAliasRequestRequestTypeDef#
# UpdateThemeAliasRequestRequestTypeDef definition
class UpdateThemeAliasRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
UpdateUserRequestRequestTypeDef#
# UpdateUserRequestRequestTypeDef definition
class UpdateUserRequestRequestTypeDef(TypedDict):
UserName: str,
AwsAccountId: str,
Namespace: str,
Email: str,
Role: UserRoleType, # (1)
CustomPermissionsName: NotRequired[str],
UnapplyCustomPermissions: NotRequired[bool],
ExternalLoginFederationProviderType: NotRequired[str],
CustomFederationProviderUrl: NotRequired[str],
ExternalLoginId: NotRequired[str],
- See UserRoleType
UpdateVPCConnectionRequestRequestTypeDef#
# UpdateVPCConnectionRequestRequestTypeDef definition
class UpdateVPCConnectionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
VPCConnectionId: str,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
RoleArn: str,
DnsResolvers: NotRequired[Sequence[str]],
WaterfallChartGroupColorConfigurationTypeDef#
# WaterfallChartGroupColorConfigurationTypeDef definition
class WaterfallChartGroupColorConfigurationTypeDef(TypedDict):
PositiveBarColor: NotRequired[str],
NegativeBarColor: NotRequired[str],
TotalBarColor: NotRequired[str],
WaterfallChartOptionsTypeDef#
# WaterfallChartOptionsTypeDef definition
class WaterfallChartOptionsTypeDef(TypedDict):
TotalBarLabel: NotRequired[str],
WordCloudOptionsTypeDef#
# WordCloudOptionsTypeDef definition
class WordCloudOptionsTypeDef(TypedDict):
WordOrientation: NotRequired[WordCloudWordOrientationType], # (1)
WordScaling: NotRequired[WordCloudWordScalingType], # (2)
CloudLayout: NotRequired[WordCloudCloudLayoutType], # (3)
WordCasing: NotRequired[WordCloudWordCasingType], # (4)
WordPadding: NotRequired[WordCloudWordPaddingType], # (5)
MaximumStringLength: NotRequired[int],
- See WordCloudWordOrientationType
- See WordCloudWordScalingType
- See WordCloudCloudLayoutType
- See WordCloudWordCasingType
- See WordCloudWordPaddingType
UpdateAccountCustomizationRequestRequestTypeDef#
# UpdateAccountCustomizationRequestRequestTypeDef definition
class UpdateAccountCustomizationRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: NotRequired[str],
AxisLabelReferenceOptionsTypeDef#
# AxisLabelReferenceOptionsTypeDef definition
class AxisLabelReferenceOptionsTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
CascadingControlSourceTypeDef#
# CascadingControlSourceTypeDef definition
class CascadingControlSourceTypeDef(TypedDict):
SourceSheetControlId: NotRequired[str],
ColumnToMatch: NotRequired[ColumnIdentifierTypeDef], # (1)
CategoryDrillDownFilterTypeDef#
# CategoryDrillDownFilterTypeDef definition
class CategoryDrillDownFilterTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
CategoryValues: Sequence[str],
ContributionAnalysisDefaultTypeDef#
# ContributionAnalysisDefaultTypeDef definition
class ContributionAnalysisDefaultTypeDef(TypedDict):
MeasureFieldId: str,
ContributorDimensions: Sequence[ColumnIdentifierTypeDef], # (1)
DynamicDefaultValueTypeDef#
# DynamicDefaultValueTypeDef definition
class DynamicDefaultValueTypeDef(TypedDict):
DefaultValueColumn: ColumnIdentifierTypeDef, # (1)
UserNameColumn: NotRequired[ColumnIdentifierTypeDef], # (1)
GroupNameColumn: NotRequired[ColumnIdentifierTypeDef], # (1)
FilterOperationSelectedFieldsConfigurationTypeDef#
# FilterOperationSelectedFieldsConfigurationTypeDef definition
class FilterOperationSelectedFieldsConfigurationTypeDef(TypedDict):
SelectedFields: NotRequired[Sequence[str]],
SelectedFieldOptions: NotRequired[SelectedFieldOptionsType], # (1)
SelectedColumns: NotRequired[Sequence[ColumnIdentifierTypeDef]], # (2)
NumericEqualityDrillDownFilterTypeDef#
# NumericEqualityDrillDownFilterTypeDef definition
class NumericEqualityDrillDownFilterTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
Value: float,
ParameterSelectableValuesTypeDef#
# ParameterSelectableValuesTypeDef definition
class ParameterSelectableValuesTypeDef(TypedDict):
Values: NotRequired[Sequence[str]],
LinkToDataSetColumn: NotRequired[ColumnIdentifierTypeDef], # (1)
AnalysisErrorTypeDef#
# AnalysisErrorTypeDef definition
class AnalysisErrorTypeDef(TypedDict):
Type: NotRequired[AnalysisErrorTypeType], # (1)
Message: NotRequired[str],
ViolatedEntities: NotRequired[List[EntityTypeDef]], # (2)
- See AnalysisErrorTypeType
- See EntityTypeDef
DashboardErrorTypeDef#
# DashboardErrorTypeDef definition
class DashboardErrorTypeDef(TypedDict):
Type: NotRequired[DashboardErrorTypeType], # (1)
Message: NotRequired[str],
ViolatedEntities: NotRequired[List[EntityTypeDef]], # (2)
- See DashboardErrorTypeType
- See EntityTypeDef
TemplateErrorTypeDef#
# TemplateErrorTypeDef definition
class TemplateErrorTypeDef(TypedDict):
Type: NotRequired[TemplateErrorTypeType], # (1)
Message: NotRequired[str],
ViolatedEntities: NotRequired[List[EntityTypeDef]], # (2)
- See TemplateErrorTypeType
- See EntityTypeDef
SearchAnalysesRequestRequestTypeDef#
# SearchAnalysesRequestRequestTypeDef definition
class SearchAnalysesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[AnalysisSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
AnalysisSourceTemplateTypeDef#
# AnalysisSourceTemplateTypeDef definition
class AnalysisSourceTemplateTypeDef(TypedDict):
DataSetReferences: Sequence[DataSetReferenceTypeDef], # (1)
Arn: str,
DashboardSourceTemplateTypeDef#
# DashboardSourceTemplateTypeDef definition
class DashboardSourceTemplateTypeDef(TypedDict):
DataSetReferences: Sequence[DataSetReferenceTypeDef], # (1)
Arn: str,
TemplateSourceAnalysisTypeDef#
# TemplateSourceAnalysisTypeDef definition
class TemplateSourceAnalysisTypeDef(TypedDict):
Arn: str,
DataSetReferences: Sequence[DataSetReferenceTypeDef], # (1)
AnonymousUserDashboardVisualEmbeddingConfigurationTypeDef#
# AnonymousUserDashboardVisualEmbeddingConfigurationTypeDef definition
class AnonymousUserDashboardVisualEmbeddingConfigurationTypeDef(TypedDict):
InitialDashboardVisualId: DashboardVisualIdTypeDef, # (1)
RegisteredUserDashboardVisualEmbeddingConfigurationTypeDef#
# RegisteredUserDashboardVisualEmbeddingConfigurationTypeDef definition
class RegisteredUserDashboardVisualEmbeddingConfigurationTypeDef(TypedDict):
InitialDashboardVisualId: DashboardVisualIdTypeDef, # (1)
ArcAxisConfigurationTypeDef#
# ArcAxisConfigurationTypeDef definition
class ArcAxisConfigurationTypeDef(TypedDict):
Range: NotRequired[ArcAxisDisplayRangeTypeDef], # (1)
ReserveRange: NotRequired[int],
AssetBundleCloudFormationOverridePropertyConfigurationTypeDef#
# AssetBundleCloudFormationOverridePropertyConfigurationTypeDef definition
class AssetBundleCloudFormationOverridePropertyConfigurationTypeDef(TypedDict):
ResourceIdOverrideConfiguration: NotRequired[AssetBundleExportJobResourceIdOverrideConfigurationTypeDef], # (1)
VPCConnections: NotRequired[List[AssetBundleExportJobVPCConnectionOverridePropertiesTypeDef]], # (2)
RefreshSchedules: NotRequired[List[AssetBundleExportJobRefreshScheduleOverridePropertiesTypeDef]], # (3)
DataSources: NotRequired[List[AssetBundleExportJobDataSourceOverridePropertiesTypeDef]], # (4)
DataSets: NotRequired[List[AssetBundleExportJobDataSetOverridePropertiesTypeDef]], # (5)
Themes: NotRequired[List[AssetBundleExportJobThemeOverridePropertiesTypeDef]], # (6)
Analyses: NotRequired[List[AssetBundleExportJobAnalysisOverridePropertiesTypeDef]], # (7)
Dashboards: NotRequired[List[AssetBundleExportJobDashboardOverridePropertiesTypeDef]], # (8)
- See AssetBundleExportJobResourceIdOverrideConfigurationTypeDef
- See AssetBundleExportJobVPCConnectionOverridePropertiesTypeDef
- See AssetBundleExportJobRefreshScheduleOverridePropertiesTypeDef
- See AssetBundleExportJobDataSourceOverridePropertiesTypeDef
- See AssetBundleExportJobDataSetOverridePropertiesTypeDef
- See AssetBundleExportJobThemeOverridePropertiesTypeDef
- See AssetBundleExportJobAnalysisOverridePropertiesTypeDef
- See AssetBundleExportJobDashboardOverridePropertiesTypeDef
AssetBundleImportJobAnalysisOverridePermissionsTypeDef#
# AssetBundleImportJobAnalysisOverridePermissionsTypeDef definition
class AssetBundleImportJobAnalysisOverridePermissionsTypeDef(TypedDict):
AnalysisIds: List[str],
Permissions: AssetBundleResourcePermissionsTypeDef, # (1)
AssetBundleImportJobDataSetOverridePermissionsTypeDef#
# AssetBundleImportJobDataSetOverridePermissionsTypeDef definition
class AssetBundleImportJobDataSetOverridePermissionsTypeDef(TypedDict):
DataSetIds: List[str],
Permissions: AssetBundleResourcePermissionsTypeDef, # (1)
AssetBundleImportJobDataSourceOverridePermissionsTypeDef#
# AssetBundleImportJobDataSourceOverridePermissionsTypeDef definition
class AssetBundleImportJobDataSourceOverridePermissionsTypeDef(TypedDict):
DataSourceIds: List[str],
Permissions: AssetBundleResourcePermissionsTypeDef, # (1)
AssetBundleImportJobThemeOverridePermissionsTypeDef#
# AssetBundleImportJobThemeOverridePermissionsTypeDef definition
class AssetBundleImportJobThemeOverridePermissionsTypeDef(TypedDict):
ThemeIds: List[str],
Permissions: AssetBundleResourcePermissionsTypeDef, # (1)
AssetBundleResourceLinkSharingConfigurationTypeDef#
# AssetBundleResourceLinkSharingConfigurationTypeDef definition
class AssetBundleResourceLinkSharingConfigurationTypeDef(TypedDict):
Permissions: NotRequired[AssetBundleResourcePermissionsTypeDef], # (1)
AssetBundleImportJobAnalysisOverrideTagsTypeDef#
# AssetBundleImportJobAnalysisOverrideTagsTypeDef definition
class AssetBundleImportJobAnalysisOverrideTagsTypeDef(TypedDict):
AnalysisIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobDashboardOverrideTagsTypeDef#
# AssetBundleImportJobDashboardOverrideTagsTypeDef definition
class AssetBundleImportJobDashboardOverrideTagsTypeDef(TypedDict):
DashboardIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobDataSetOverrideTagsTypeDef#
# AssetBundleImportJobDataSetOverrideTagsTypeDef definition
class AssetBundleImportJobDataSetOverrideTagsTypeDef(TypedDict):
DataSetIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobDataSourceOverrideTagsTypeDef#
# AssetBundleImportJobDataSourceOverrideTagsTypeDef definition
class AssetBundleImportJobDataSourceOverrideTagsTypeDef(TypedDict):
DataSourceIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobThemeOverrideTagsTypeDef#
# AssetBundleImportJobThemeOverrideTagsTypeDef definition
class AssetBundleImportJobThemeOverrideTagsTypeDef(TypedDict):
ThemeIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobVPCConnectionOverrideTagsTypeDef#
# AssetBundleImportJobVPCConnectionOverrideTagsTypeDef definition
class AssetBundleImportJobVPCConnectionOverrideTagsTypeDef(TypedDict):
VPCConnectionIds: List[str],
Tags: List[TagTypeDef], # (1)
- See TagTypeDef
CreateAccountCustomizationRequestRequestTypeDef#
# CreateAccountCustomizationRequestRequestTypeDef definition
class CreateAccountCustomizationRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
CreateNamespaceRequestRequestTypeDef#
# CreateNamespaceRequestRequestTypeDef definition
class CreateNamespaceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
IdentityStore: IdentityStoreType, # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See IdentityStoreType
- See TagTypeDef
CreateVPCConnectionRequestRequestTypeDef#
# CreateVPCConnectionRequestRequestTypeDef definition
class CreateVPCConnectionRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
VPCConnectionId: str,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
RoleArn: str,
DnsResolvers: NotRequired[Sequence[str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
RegisterUserRequestRequestTypeDef#
# RegisterUserRequestRequestTypeDef definition
class RegisterUserRequestRequestTypeDef(TypedDict):
IdentityType: IdentityTypeType, # (1)
Email: str,
UserRole: UserRoleType, # (2)
AwsAccountId: str,
Namespace: str,
IamArn: NotRequired[str],
SessionName: NotRequired[str],
UserName: NotRequired[str],
CustomPermissionsName: NotRequired[str],
ExternalLoginFederationProviderType: NotRequired[str],
CustomFederationProviderUrl: NotRequired[str],
ExternalLoginId: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See IdentityTypeType
- See UserRoleType
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
AssetBundleImportJobDataSourceCredentialsTypeDef#
# AssetBundleImportJobDataSourceCredentialsTypeDef definition
class AssetBundleImportJobDataSourceCredentialsTypeDef(TypedDict):
CredentialPair: NotRequired[AssetBundleImportJobDataSourceCredentialPairTypeDef], # (1)
SecretArn: NotRequired[str],
AssetBundleImportSourceTypeDef#
# AssetBundleImportSourceTypeDef definition
class AssetBundleImportSourceTypeDef(TypedDict):
Body: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
S3Uri: NotRequired[str],
AxisDisplayRangeTypeDef#
# AxisDisplayRangeTypeDef definition
class AxisDisplayRangeTypeDef(TypedDict):
MinMax: NotRequired[AxisDisplayMinMaxRangeTypeDef], # (1)
DataDriven: NotRequired[Mapping[str, Any]],
AxisScaleTypeDef#
# AxisScaleTypeDef definition
class AxisScaleTypeDef(TypedDict):
Linear: NotRequired[AxisLinearScaleTypeDef], # (1)
Logarithmic: NotRequired[AxisLogarithmicScaleTypeDef], # (2)
ScatterPlotSortConfigurationTypeDef#
# ScatterPlotSortConfigurationTypeDef definition
class ScatterPlotSortConfigurationTypeDef(TypedDict):
ScatterPlotLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (1)
HistogramBinOptionsTypeDef#
# HistogramBinOptionsTypeDef definition
class HistogramBinOptionsTypeDef(TypedDict):
SelectedBinType: NotRequired[HistogramBinTypeType], # (1)
BinCount: NotRequired[BinCountOptionsTypeDef], # (2)
BinWidth: NotRequired[BinWidthOptionsTypeDef], # (3)
StartValue: NotRequired[float],
TileStyleTypeDef#
# TileStyleTypeDef definition
class TileStyleTypeDef(TypedDict):
Border: NotRequired[BorderStyleTypeDef], # (1)
BoxPlotOptionsTypeDef#
# BoxPlotOptionsTypeDef definition
class BoxPlotOptionsTypeDef(TypedDict):
StyleOptions: NotRequired[BoxPlotStyleOptionsTypeDef], # (1)
OutlierVisibility: NotRequired[VisibilityType], # (2)
AllDataPointsVisibility: NotRequired[VisibilityType], # (2)
- See BoxPlotStyleOptionsTypeDef
- See VisibilityType
- See VisibilityType
CreateColumnsOperationTypeDef#
# CreateColumnsOperationTypeDef definition
class CreateColumnsOperationTypeDef(TypedDict):
Columns: Sequence[CalculatedColumnTypeDef], # (1)
CancelIngestionResponseTypeDef#
# CancelIngestionResponseTypeDef definition
class CancelIngestionResponseTypeDef(TypedDict):
Arn: str,
IngestionId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAccountCustomizationResponseTypeDef#
# CreateAccountCustomizationResponseTypeDef definition
class CreateAccountCustomizationResponseTypeDef(TypedDict):
Arn: str,
AwsAccountId: str,
Namespace: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateAnalysisResponseTypeDef#
# CreateAnalysisResponseTypeDef definition
class CreateAnalysisResponseTypeDef(TypedDict):
Arn: str,
AnalysisId: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDashboardResponseTypeDef#
# CreateDashboardResponseTypeDef definition
class CreateDashboardResponseTypeDef(TypedDict):
Arn: str,
VersionArn: str,
DashboardId: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDataSetResponseTypeDef#
# CreateDataSetResponseTypeDef definition
class CreateDataSetResponseTypeDef(TypedDict):
Arn: str,
DataSetId: str,
IngestionArn: str,
IngestionId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDataSourceResponseTypeDef#
# CreateDataSourceResponseTypeDef definition
class CreateDataSourceResponseTypeDef(TypedDict):
Arn: str,
DataSourceId: str,
CreationStatus: ResourceStatusType, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateFolderResponseTypeDef#
# CreateFolderResponseTypeDef definition
class CreateFolderResponseTypeDef(TypedDict):
Status: int,
Arn: str,
FolderId: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateIAMPolicyAssignmentResponseTypeDef#
# CreateIAMPolicyAssignmentResponseTypeDef definition
class CreateIAMPolicyAssignmentResponseTypeDef(TypedDict):
AssignmentName: str,
AssignmentId: str,
AssignmentStatus: AssignmentStatusType, # (1)
PolicyArn: str,
Identities: Dict[str, List[str]],
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateIngestionResponseTypeDef#
# CreateIngestionResponseTypeDef definition
class CreateIngestionResponseTypeDef(TypedDict):
Arn: str,
IngestionId: str,
IngestionStatus: IngestionStatusType, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNamespaceResponseTypeDef#
# CreateNamespaceResponseTypeDef definition
class CreateNamespaceResponseTypeDef(TypedDict):
Arn: str,
Name: str,
CapacityRegion: str,
CreationStatus: NamespaceStatusType, # (1)
IdentityStore: IdentityStoreType, # (2)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
CreateRefreshScheduleResponseTypeDef#
# CreateRefreshScheduleResponseTypeDef definition
class CreateRefreshScheduleResponseTypeDef(TypedDict):
Status: int,
RequestId: str,
ScheduleId: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateRoleMembershipResponseTypeDef#
# CreateRoleMembershipResponseTypeDef definition
class CreateRoleMembershipResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTemplateResponseTypeDef#
# CreateTemplateResponseTypeDef definition
class CreateTemplateResponseTypeDef(TypedDict):
Arn: str,
VersionArn: str,
TemplateId: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateThemeResponseTypeDef#
# CreateThemeResponseTypeDef definition
class CreateThemeResponseTypeDef(TypedDict):
Arn: str,
VersionArn: str,
ThemeId: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateTopicRefreshScheduleResponseTypeDef#
# CreateTopicRefreshScheduleResponseTypeDef definition
class CreateTopicRefreshScheduleResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
DatasetArn: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTopicResponseTypeDef#
# CreateTopicResponseTypeDef definition
class CreateTopicResponseTypeDef(TypedDict):
Arn: str,
TopicId: str,
RefreshArn: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateVPCConnectionResponseTypeDef#
# CreateVPCConnectionResponseTypeDef definition
class CreateVPCConnectionResponseTypeDef(TypedDict):
Arn: str,
VPCConnectionId: str,
CreationStatus: VPCConnectionResourceStatusType, # (1)
AvailabilityStatus: VPCConnectionAvailabilityStatusType, # (2)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See VPCConnectionResourceStatusType
- See VPCConnectionAvailabilityStatusType
- See ResponseMetadataTypeDef
DeleteAccountCustomizationResponseTypeDef#
# DeleteAccountCustomizationResponseTypeDef definition
class DeleteAccountCustomizationResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteAccountSubscriptionResponseTypeDef#
# DeleteAccountSubscriptionResponseTypeDef definition
class DeleteAccountSubscriptionResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteAnalysisResponseTypeDef#
# DeleteAnalysisResponseTypeDef definition
class DeleteAnalysisResponseTypeDef(TypedDict):
Status: int,
Arn: str,
AnalysisId: str,
DeletionTime: datetime,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDashboardResponseTypeDef#
# DeleteDashboardResponseTypeDef definition
class DeleteDashboardResponseTypeDef(TypedDict):
Status: int,
Arn: str,
DashboardId: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDataSetRefreshPropertiesResponseTypeDef#
# DeleteDataSetRefreshPropertiesResponseTypeDef definition
class DeleteDataSetRefreshPropertiesResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDataSetResponseTypeDef#
# DeleteDataSetResponseTypeDef definition
class DeleteDataSetResponseTypeDef(TypedDict):
Arn: str,
DataSetId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDataSourceResponseTypeDef#
# DeleteDataSourceResponseTypeDef definition
class DeleteDataSourceResponseTypeDef(TypedDict):
Arn: str,
DataSourceId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteFolderMembershipResponseTypeDef#
# DeleteFolderMembershipResponseTypeDef definition
class DeleteFolderMembershipResponseTypeDef(TypedDict):
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteFolderResponseTypeDef#
# DeleteFolderResponseTypeDef definition
class DeleteFolderResponseTypeDef(TypedDict):
Status: int,
Arn: str,
FolderId: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteGroupMembershipResponseTypeDef#
# DeleteGroupMembershipResponseTypeDef definition
class DeleteGroupMembershipResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteGroupResponseTypeDef#
# DeleteGroupResponseTypeDef definition
class DeleteGroupResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteIAMPolicyAssignmentResponseTypeDef#
# DeleteIAMPolicyAssignmentResponseTypeDef definition
class DeleteIAMPolicyAssignmentResponseTypeDef(TypedDict):
AssignmentName: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteIdentityPropagationConfigResponseTypeDef#
# DeleteIdentityPropagationConfigResponseTypeDef definition
class DeleteIdentityPropagationConfigResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteNamespaceResponseTypeDef#
# DeleteNamespaceResponseTypeDef definition
class DeleteNamespaceResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteRefreshScheduleResponseTypeDef#
# DeleteRefreshScheduleResponseTypeDef definition
class DeleteRefreshScheduleResponseTypeDef(TypedDict):
Status: int,
RequestId: str,
ScheduleId: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteRoleCustomPermissionResponseTypeDef#
# DeleteRoleCustomPermissionResponseTypeDef definition
class DeleteRoleCustomPermissionResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteRoleMembershipResponseTypeDef#
# DeleteRoleMembershipResponseTypeDef definition
class DeleteRoleMembershipResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTemplateAliasResponseTypeDef#
# DeleteTemplateAliasResponseTypeDef definition
class DeleteTemplateAliasResponseTypeDef(TypedDict):
Status: int,
TemplateId: str,
AliasName: str,
Arn: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTemplateResponseTypeDef#
# DeleteTemplateResponseTypeDef definition
class DeleteTemplateResponseTypeDef(TypedDict):
RequestId: str,
Arn: str,
TemplateId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteThemeAliasResponseTypeDef#
# DeleteThemeAliasResponseTypeDef definition
class DeleteThemeAliasResponseTypeDef(TypedDict):
AliasName: str,
Arn: str,
RequestId: str,
Status: int,
ThemeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteThemeResponseTypeDef#
# DeleteThemeResponseTypeDef definition
class DeleteThemeResponseTypeDef(TypedDict):
Arn: str,
RequestId: str,
Status: int,
ThemeId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTopicRefreshScheduleResponseTypeDef#
# DeleteTopicRefreshScheduleResponseTypeDef definition
class DeleteTopicRefreshScheduleResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
DatasetArn: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteTopicResponseTypeDef#
# DeleteTopicResponseTypeDef definition
class DeleteTopicResponseTypeDef(TypedDict):
Arn: str,
TopicId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteUserByPrincipalIdResponseTypeDef#
# DeleteUserByPrincipalIdResponseTypeDef definition
class DeleteUserByPrincipalIdResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteUserResponseTypeDef#
# DeleteUserResponseTypeDef definition
class DeleteUserResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteVPCConnectionResponseTypeDef#
# DeleteVPCConnectionResponseTypeDef definition
class DeleteVPCConnectionResponseTypeDef(TypedDict):
Arn: str,
VPCConnectionId: str,
DeletionStatus: VPCConnectionResourceStatusType, # (1)
AvailabilityStatus: VPCConnectionAvailabilityStatusType, # (2)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See VPCConnectionResourceStatusType
- See VPCConnectionAvailabilityStatusType
- See ResponseMetadataTypeDef
DescribeAccountCustomizationResponseTypeDef#
# DescribeAccountCustomizationResponseTypeDef definition
class DescribeAccountCustomizationResponseTypeDef(TypedDict):
Arn: str,
AwsAccountId: str,
Namespace: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccountSettingsResponseTypeDef#
# DescribeAccountSettingsResponseTypeDef definition
class DescribeAccountSettingsResponseTypeDef(TypedDict):
AccountSettings: AccountSettingsTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAccountSubscriptionResponseTypeDef#
# DescribeAccountSubscriptionResponseTypeDef definition
class DescribeAccountSubscriptionResponseTypeDef(TypedDict):
AccountInfo: AccountInfoTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeIpRestrictionResponseTypeDef#
# DescribeIpRestrictionResponseTypeDef definition
class DescribeIpRestrictionResponseTypeDef(TypedDict):
AwsAccountId: str,
IpRestrictionRuleMap: Dict[str, str],
Enabled: bool,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeRoleCustomPermissionResponseTypeDef#
# DescribeRoleCustomPermissionResponseTypeDef definition
class DescribeRoleCustomPermissionResponseTypeDef(TypedDict):
CustomPermissionsName: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateEmbedUrlForAnonymousUserResponseTypeDef#
# GenerateEmbedUrlForAnonymousUserResponseTypeDef definition
class GenerateEmbedUrlForAnonymousUserResponseTypeDef(TypedDict):
EmbedUrl: str,
Status: int,
RequestId: str,
AnonymousUserArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GenerateEmbedUrlForRegisteredUserResponseTypeDef#
# GenerateEmbedUrlForRegisteredUserResponseTypeDef definition
class GenerateEmbedUrlForRegisteredUserResponseTypeDef(TypedDict):
EmbedUrl: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetDashboardEmbedUrlResponseTypeDef#
# GetDashboardEmbedUrlResponseTypeDef definition
class GetDashboardEmbedUrlResponseTypeDef(TypedDict):
EmbedUrl: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetSessionEmbedUrlResponseTypeDef#
# GetSessionEmbedUrlResponseTypeDef definition
class GetSessionEmbedUrlResponseTypeDef(TypedDict):
EmbedUrl: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAnalysesResponseTypeDef#
# ListAnalysesResponseTypeDef definition
class ListAnalysesResponseTypeDef(TypedDict):
AnalysisSummaryList: List[AnalysisSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetBundleExportJobsResponseTypeDef#
# ListAssetBundleExportJobsResponseTypeDef definition
class ListAssetBundleExportJobsResponseTypeDef(TypedDict):
AssetBundleExportJobSummaryList: List[AssetBundleExportJobSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAssetBundleImportJobsResponseTypeDef#
# ListAssetBundleImportJobsResponseTypeDef definition
class ListAssetBundleImportJobsResponseTypeDef(TypedDict):
AssetBundleImportJobSummaryList: List[AssetBundleImportJobSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIAMPolicyAssignmentsForUserResponseTypeDef#
# ListIAMPolicyAssignmentsForUserResponseTypeDef definition
class ListIAMPolicyAssignmentsForUserResponseTypeDef(TypedDict):
ActiveAssignments: List[ActiveIAMPolicyAssignmentTypeDef], # (1)
RequestId: str,
NextToken: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIdentityPropagationConfigsResponseTypeDef#
# ListIdentityPropagationConfigsResponseTypeDef definition
class ListIdentityPropagationConfigsResponseTypeDef(TypedDict):
Services: List[AuthorizedTargetsByServiceTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRoleMembershipsResponseTypeDef#
# ListRoleMembershipsResponseTypeDef definition
class ListRoleMembershipsResponseTypeDef(TypedDict):
MembersList: List[str],
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
PutDataSetRefreshPropertiesResponseTypeDef#
# PutDataSetRefreshPropertiesResponseTypeDef definition
class PutDataSetRefreshPropertiesResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
RestoreAnalysisResponseTypeDef#
# RestoreAnalysisResponseTypeDef definition
class RestoreAnalysisResponseTypeDef(TypedDict):
Status: int,
Arn: str,
AnalysisId: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SearchAnalysesResponseTypeDef#
# SearchAnalysesResponseTypeDef definition
class SearchAnalysesResponseTypeDef(TypedDict):
AnalysisSummaryList: List[AnalysisSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartAssetBundleExportJobResponseTypeDef#
# StartAssetBundleExportJobResponseTypeDef definition
class StartAssetBundleExportJobResponseTypeDef(TypedDict):
Arn: str,
AssetBundleExportJobId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartAssetBundleImportJobResponseTypeDef#
# StartAssetBundleImportJobResponseTypeDef definition
class StartAssetBundleImportJobResponseTypeDef(TypedDict):
Arn: str,
AssetBundleImportJobId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartDashboardSnapshotJobResponseTypeDef#
# StartDashboardSnapshotJobResponseTypeDef definition
class StartDashboardSnapshotJobResponseTypeDef(TypedDict):
Arn: str,
SnapshotJobId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagResourceResponseTypeDef#
# TagResourceResponseTypeDef definition
class TagResourceResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UntagResourceResponseTypeDef#
# UntagResourceResponseTypeDef definition
class UntagResourceResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAccountCustomizationResponseTypeDef#
# UpdateAccountCustomizationResponseTypeDef definition
class UpdateAccountCustomizationResponseTypeDef(TypedDict):
Arn: str,
AwsAccountId: str,
Namespace: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateAccountSettingsResponseTypeDef#
# UpdateAccountSettingsResponseTypeDef definition
class UpdateAccountSettingsResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAnalysisResponseTypeDef#
# UpdateAnalysisResponseTypeDef definition
class UpdateAnalysisResponseTypeDef(TypedDict):
Arn: str,
AnalysisId: str,
UpdateStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDashboardLinksResponseTypeDef#
# UpdateDashboardLinksResponseTypeDef definition
class UpdateDashboardLinksResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
DashboardArn: str,
LinkEntities: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDashboardPublishedVersionResponseTypeDef#
# UpdateDashboardPublishedVersionResponseTypeDef definition
class UpdateDashboardPublishedVersionResponseTypeDef(TypedDict):
DashboardId: str,
DashboardArn: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDashboardResponseTypeDef#
# UpdateDashboardResponseTypeDef definition
class UpdateDashboardResponseTypeDef(TypedDict):
Arn: str,
VersionArn: str,
DashboardId: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDataSetPermissionsResponseTypeDef#
# UpdateDataSetPermissionsResponseTypeDef definition
class UpdateDataSetPermissionsResponseTypeDef(TypedDict):
DataSetArn: str,
DataSetId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDataSetResponseTypeDef#
# UpdateDataSetResponseTypeDef definition
class UpdateDataSetResponseTypeDef(TypedDict):
Arn: str,
DataSetId: str,
IngestionArn: str,
IngestionId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDataSourcePermissionsResponseTypeDef#
# UpdateDataSourcePermissionsResponseTypeDef definition
class UpdateDataSourcePermissionsResponseTypeDef(TypedDict):
DataSourceArn: str,
DataSourceId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDataSourceResponseTypeDef#
# UpdateDataSourceResponseTypeDef definition
class UpdateDataSourceResponseTypeDef(TypedDict):
Arn: str,
DataSourceId: str,
UpdateStatus: ResourceStatusType, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateFolderResponseTypeDef#
# UpdateFolderResponseTypeDef definition
class UpdateFolderResponseTypeDef(TypedDict):
Status: int,
Arn: str,
FolderId: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateIAMPolicyAssignmentResponseTypeDef#
# UpdateIAMPolicyAssignmentResponseTypeDef definition
class UpdateIAMPolicyAssignmentResponseTypeDef(TypedDict):
AssignmentName: str,
AssignmentId: str,
PolicyArn: str,
Identities: Dict[str, List[str]],
AssignmentStatus: AssignmentStatusType, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateIdentityPropagationConfigResponseTypeDef#
# UpdateIdentityPropagationConfigResponseTypeDef definition
class UpdateIdentityPropagationConfigResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateIpRestrictionResponseTypeDef#
# UpdateIpRestrictionResponseTypeDef definition
class UpdateIpRestrictionResponseTypeDef(TypedDict):
AwsAccountId: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdatePublicSharingSettingsResponseTypeDef#
# UpdatePublicSharingSettingsResponseTypeDef definition
class UpdatePublicSharingSettingsResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRefreshScheduleResponseTypeDef#
# UpdateRefreshScheduleResponseTypeDef definition
class UpdateRefreshScheduleResponseTypeDef(TypedDict):
Status: int,
RequestId: str,
ScheduleId: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateRoleCustomPermissionResponseTypeDef#
# UpdateRoleCustomPermissionResponseTypeDef definition
class UpdateRoleCustomPermissionResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTemplateResponseTypeDef#
# UpdateTemplateResponseTypeDef definition
class UpdateTemplateResponseTypeDef(TypedDict):
TemplateId: str,
Arn: str,
VersionArn: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateThemeResponseTypeDef#
# UpdateThemeResponseTypeDef definition
class UpdateThemeResponseTypeDef(TypedDict):
ThemeId: str,
Arn: str,
VersionArn: str,
CreationStatus: ResourceStatusType, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTopicRefreshScheduleResponseTypeDef#
# UpdateTopicRefreshScheduleResponseTypeDef definition
class UpdateTopicRefreshScheduleResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
DatasetArn: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTopicResponseTypeDef#
# UpdateTopicResponseTypeDef definition
class UpdateTopicResponseTypeDef(TypedDict):
TopicId: str,
Arn: str,
RefreshArn: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateVPCConnectionResponseTypeDef#
# UpdateVPCConnectionResponseTypeDef definition
class UpdateVPCConnectionResponseTypeDef(TypedDict):
Arn: str,
VPCConnectionId: str,
UpdateStatus: VPCConnectionResourceStatusType, # (1)
AvailabilityStatus: VPCConnectionAvailabilityStatusType, # (2)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See VPCConnectionResourceStatusType
- See VPCConnectionAvailabilityStatusType
- See ResponseMetadataTypeDef
CategoryFilterConfigurationTypeDef#
# CategoryFilterConfigurationTypeDef definition
class CategoryFilterConfigurationTypeDef(TypedDict):
FilterListConfiguration: NotRequired[FilterListConfigurationTypeDef], # (1)
CustomFilterListConfiguration: NotRequired[CustomFilterListConfigurationTypeDef], # (2)
CustomFilterConfiguration: NotRequired[CustomFilterConfigurationTypeDef], # (3)
- See FilterListConfigurationTypeDef
- See CustomFilterListConfigurationTypeDef
- See CustomFilterConfigurationTypeDef
ClusterMarkerTypeDef#
# ClusterMarkerTypeDef definition
class ClusterMarkerTypeDef(TypedDict):
SimpleClusterMarker: NotRequired[SimpleClusterMarkerTypeDef], # (1)
TopicCategoryFilterConstantTypeDef#
# TopicCategoryFilterConstantTypeDef definition
class TopicCategoryFilterConstantTypeDef(TypedDict):
ConstantType: NotRequired[ConstantTypeType], # (1)
SingularConstant: NotRequired[str],
CollectiveConstant: NotRequired[CollectiveConstantTypeDef], # (2)
ColorScaleTypeDef#
# ColorScaleTypeDef definition
class ColorScaleTypeDef(TypedDict):
Colors: Sequence[DataColorTypeDef], # (1)
ColorFillType: ColorFillTypeType, # (2)
NullValueColor: NotRequired[DataColorTypeDef], # (3)
- See DataColorTypeDef
- See ColorFillTypeType
- See DataColorTypeDef
ColorsConfigurationTypeDef#
# ColorsConfigurationTypeDef definition
class ColorsConfigurationTypeDef(TypedDict):
CustomColors: NotRequired[Sequence[CustomColorTypeDef]], # (1)
ColumnTagTypeDef#
# ColumnTagTypeDef definition
class ColumnTagTypeDef(TypedDict):
ColumnGeographicRole: NotRequired[GeoSpatialDataRoleType], # (1)
ColumnDescription: NotRequired[ColumnDescriptionTypeDef], # (2)
ColumnGroupSchemaTypeDef#
# ColumnGroupSchemaTypeDef definition
class ColumnGroupSchemaTypeDef(TypedDict):
Name: NotRequired[str],
ColumnGroupColumnSchemaList: NotRequired[Sequence[ColumnGroupColumnSchemaTypeDef]], # (1)
ColumnGroupTypeDef#
# ColumnGroupTypeDef definition
class ColumnGroupTypeDef(TypedDict):
GeoSpatialColumnGroup: NotRequired[GeoSpatialColumnGroupTypeDef], # (1)
DataSetSchemaTypeDef#
# DataSetSchemaTypeDef definition
class DataSetSchemaTypeDef(TypedDict):
ColumnSchemaList: NotRequired[Sequence[ColumnSchemaTypeDef]], # (1)
ConditionalFormattingCustomIconConditionTypeDef#
# ConditionalFormattingCustomIconConditionTypeDef definition
class ConditionalFormattingCustomIconConditionTypeDef(TypedDict):
Expression: str,
IconOptions: ConditionalFormattingCustomIconOptionsTypeDef, # (1)
Color: NotRequired[str],
DisplayConfiguration: NotRequired[ConditionalFormattingIconDisplayConfigurationTypeDef], # (2)
- See ConditionalFormattingCustomIconOptionsTypeDef
- See ConditionalFormattingIconDisplayConfigurationTypeDef
CreateAccountSubscriptionResponseTypeDef#
# CreateAccountSubscriptionResponseTypeDef definition
class CreateAccountSubscriptionResponseTypeDef(TypedDict):
SignupResponse: SignupResponseTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateFolderRequestRequestTypeDef#
# CreateFolderRequestRequestTypeDef definition
class CreateFolderRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Name: NotRequired[str],
FolderType: NotRequired[FolderTypeType], # (1)
ParentFolderArn: NotRequired[str],
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
SharingModel: NotRequired[SharingModelType], # (4)
- See FolderTypeType
- See ResourcePermissionTypeDef
- See TagTypeDef
- See SharingModelType
DescribeAnalysisPermissionsResponseTypeDef#
# DescribeAnalysisPermissionsResponseTypeDef definition
class DescribeAnalysisPermissionsResponseTypeDef(TypedDict):
AnalysisId: str,
AnalysisArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDataSetPermissionsResponseTypeDef#
# DescribeDataSetPermissionsResponseTypeDef definition
class DescribeDataSetPermissionsResponseTypeDef(TypedDict):
DataSetArn: str,
DataSetId: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeDataSourcePermissionsResponseTypeDef#
# DescribeDataSourcePermissionsResponseTypeDef definition
class DescribeDataSourcePermissionsResponseTypeDef(TypedDict):
DataSourceArn: str,
DataSourceId: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFolderPermissionsResponseTypeDef#
# DescribeFolderPermissionsResponseTypeDef definition
class DescribeFolderPermissionsResponseTypeDef(TypedDict):
Status: int,
FolderId: str,
Arn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFolderResolvedPermissionsResponseTypeDef#
# DescribeFolderResolvedPermissionsResponseTypeDef definition
class DescribeFolderResolvedPermissionsResponseTypeDef(TypedDict):
Status: int,
FolderId: str,
Arn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTemplatePermissionsResponseTypeDef#
# DescribeTemplatePermissionsResponseTypeDef definition
class DescribeTemplatePermissionsResponseTypeDef(TypedDict):
TemplateId: str,
TemplateArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeThemePermissionsResponseTypeDef#
# DescribeThemePermissionsResponseTypeDef definition
class DescribeThemePermissionsResponseTypeDef(TypedDict):
ThemeId: str,
ThemeArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTopicPermissionsResponseTypeDef#
# DescribeTopicPermissionsResponseTypeDef definition
class DescribeTopicPermissionsResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LinkSharingConfigurationTypeDef#
# LinkSharingConfigurationTypeDef definition
class LinkSharingConfigurationTypeDef(TypedDict):
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateAnalysisPermissionsRequestRequestTypeDef#
# UpdateAnalysisPermissionsRequestRequestTypeDef definition
class UpdateAnalysisPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateAnalysisPermissionsResponseTypeDef#
# UpdateAnalysisPermissionsResponseTypeDef definition
class UpdateAnalysisPermissionsResponseTypeDef(TypedDict):
AnalysisArn: str,
AnalysisId: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateDashboardPermissionsRequestRequestTypeDef#
# UpdateDashboardPermissionsRequestRequestTypeDef definition
class UpdateDashboardPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
GrantLinkPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokeLinkPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
UpdateDataSetPermissionsRequestRequestTypeDef#
# UpdateDataSetPermissionsRequestRequestTypeDef definition
class UpdateDataSetPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateDataSourcePermissionsRequestRequestTypeDef#
# UpdateDataSourcePermissionsRequestRequestTypeDef definition
class UpdateDataSourcePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateFolderPermissionsRequestRequestTypeDef#
# UpdateFolderPermissionsRequestRequestTypeDef definition
class UpdateFolderPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateFolderPermissionsResponseTypeDef#
# UpdateFolderPermissionsResponseTypeDef definition
class UpdateFolderPermissionsResponseTypeDef(TypedDict):
Status: int,
Arn: str,
FolderId: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTemplatePermissionsRequestRequestTypeDef#
# UpdateTemplatePermissionsRequestRequestTypeDef definition
class UpdateTemplatePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateTemplatePermissionsResponseTypeDef#
# UpdateTemplatePermissionsResponseTypeDef definition
class UpdateTemplatePermissionsResponseTypeDef(TypedDict):
TemplateId: str,
TemplateArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateThemePermissionsRequestRequestTypeDef#
# UpdateThemePermissionsRequestRequestTypeDef definition
class UpdateThemePermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateThemePermissionsResponseTypeDef#
# UpdateThemePermissionsResponseTypeDef definition
class UpdateThemePermissionsResponseTypeDef(TypedDict):
ThemeId: str,
ThemeArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTopicPermissionsRequestRequestTypeDef#
# UpdateTopicPermissionsRequestRequestTypeDef definition
class UpdateTopicPermissionsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
GrantPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
RevokePermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
UpdateTopicPermissionsResponseTypeDef#
# UpdateTopicPermissionsResponseTypeDef definition
class UpdateTopicPermissionsResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DataSetSummaryTypeDef#
# DataSetSummaryTypeDef definition
class DataSetSummaryTypeDef(TypedDict):
Arn: NotRequired[str],
DataSetId: NotRequired[str],
Name: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
ImportMode: NotRequired[DataSetImportModeType], # (1)
RowLevelPermissionDataSet: NotRequired[RowLevelPermissionDataSetTypeDef], # (2)
RowLevelPermissionTagConfigurationApplied: NotRequired[bool],
ColumnLevelPermissionRulesApplied: NotRequired[bool],
CreateFolderMembershipResponseTypeDef#
# CreateFolderMembershipResponseTypeDef definition
class CreateFolderMembershipResponseTypeDef(TypedDict):
Status: int,
FolderMember: FolderMemberTypeDef, # (1)
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGroupMembershipResponseTypeDef#
# CreateGroupMembershipResponseTypeDef definition
class CreateGroupMembershipResponseTypeDef(TypedDict):
GroupMember: GroupMemberTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeGroupMembershipResponseTypeDef#
# DescribeGroupMembershipResponseTypeDef definition
class DescribeGroupMembershipResponseTypeDef(TypedDict):
GroupMember: GroupMemberTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListGroupMembershipsResponseTypeDef#
# ListGroupMembershipsResponseTypeDef definition
class ListGroupMembershipsResponseTypeDef(TypedDict):
GroupMemberList: List[GroupMemberTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateGroupResponseTypeDef#
# CreateGroupResponseTypeDef definition
class CreateGroupResponseTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
DescribeGroupResponseTypeDef#
# DescribeGroupResponseTypeDef definition
class DescribeGroupResponseTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
ListGroupsResponseTypeDef#
# ListGroupsResponseTypeDef definition
class ListGroupsResponseTypeDef(TypedDict):
GroupList: List[GroupTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
ListUserGroupsResponseTypeDef#
# ListUserGroupsResponseTypeDef definition
class ListUserGroupsResponseTypeDef(TypedDict):
GroupList: List[GroupTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
SearchGroupsResponseTypeDef#
# SearchGroupsResponseTypeDef definition
class SearchGroupsResponseTypeDef(TypedDict):
GroupList: List[GroupTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
UpdateGroupResponseTypeDef#
# UpdateGroupResponseTypeDef definition
class UpdateGroupResponseTypeDef(TypedDict):
Group: GroupTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See GroupTypeDef
- See ResponseMetadataTypeDef
CreateTemplateAliasResponseTypeDef#
# CreateTemplateAliasResponseTypeDef definition
class CreateTemplateAliasResponseTypeDef(TypedDict):
TemplateAlias: TemplateAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTemplateAliasResponseTypeDef#
# DescribeTemplateAliasResponseTypeDef definition
class DescribeTemplateAliasResponseTypeDef(TypedDict):
TemplateAlias: TemplateAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTemplateAliasesResponseTypeDef#
# ListTemplateAliasesResponseTypeDef definition
class ListTemplateAliasesResponseTypeDef(TypedDict):
TemplateAliasList: List[TemplateAliasTypeDef], # (1)
Status: int,
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTemplateAliasResponseTypeDef#
# UpdateTemplateAliasResponseTypeDef definition
class UpdateTemplateAliasResponseTypeDef(TypedDict):
TemplateAlias: TemplateAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateThemeAliasResponseTypeDef#
# CreateThemeAliasResponseTypeDef definition
class CreateThemeAliasResponseTypeDef(TypedDict):
ThemeAlias: ThemeAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeThemeAliasResponseTypeDef#
# DescribeThemeAliasResponseTypeDef definition
class DescribeThemeAliasResponseTypeDef(TypedDict):
ThemeAlias: ThemeAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThemeAliasesResponseTypeDef#
# ListThemeAliasesResponseTypeDef definition
class ListThemeAliasesResponseTypeDef(TypedDict):
ThemeAliasList: List[ThemeAliasTypeDef], # (1)
Status: int,
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateThemeAliasResponseTypeDef#
# UpdateThemeAliasResponseTypeDef definition
class UpdateThemeAliasResponseTypeDef(TypedDict):
ThemeAlias: ThemeAliasTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomActionNavigationOperationTypeDef#
# CustomActionNavigationOperationTypeDef definition
class CustomActionNavigationOperationTypeDef(TypedDict):
LocalNavigationConfiguration: NotRequired[LocalNavigationConfigurationTypeDef], # (1)
CustomParameterValuesTypeDef#
# CustomParameterValuesTypeDef definition
class CustomParameterValuesTypeDef(TypedDict):
StringValues: NotRequired[Sequence[str]],
IntegerValues: NotRequired[Sequence[int]],
DecimalValues: NotRequired[Sequence[float]],
DateTimeValues: NotRequired[Sequence[Union[datetime, str]]],
DateTimeDatasetParameterDefaultValuesTypeDef#
# DateTimeDatasetParameterDefaultValuesTypeDef definition
class DateTimeDatasetParameterDefaultValuesTypeDef(TypedDict):
StaticValues: NotRequired[Sequence[Union[datetime, str]]],
DateTimeParameterTypeDef#
# DateTimeParameterTypeDef definition
class DateTimeParameterTypeDef(TypedDict):
Name: str,
Values: Sequence[Union[datetime, str]],
DateTimeValueWhenUnsetConfigurationTypeDef#
# DateTimeValueWhenUnsetConfigurationTypeDef definition
class DateTimeValueWhenUnsetConfigurationTypeDef(TypedDict):
ValueWhenUnsetOption: NotRequired[ValueWhenUnsetOptionType], # (1)
CustomValue: NotRequired[Union[datetime, str]],
NewDefaultValuesTypeDef#
# NewDefaultValuesTypeDef definition
class NewDefaultValuesTypeDef(TypedDict):
StringStaticValues: NotRequired[Sequence[str]],
DecimalStaticValues: NotRequired[Sequence[float]],
DateTimeStaticValues: NotRequired[Sequence[Union[datetime, str]]],
IntegerStaticValues: NotRequired[Sequence[int]],
TimeRangeDrillDownFilterTypeDef#
# TimeRangeDrillDownFilterTypeDef definition
class TimeRangeDrillDownFilterTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
RangeMinimum: Union[datetime, str],
RangeMaximum: Union[datetime, str],
TimeGranularity: TimeGranularityType, # (2)
TopicRefreshScheduleTypeDef#
# TopicRefreshScheduleTypeDef definition
class TopicRefreshScheduleTypeDef(TypedDict):
IsEnabled: bool,
BasedOnSpiceSchedule: bool,
StartingAt: NotRequired[Union[datetime, str]],
Timezone: NotRequired[str],
RepeatAt: NotRequired[str],
TopicScheduleType: NotRequired[TopicScheduleTypeType], # (1)
WhatIfPointScenarioTypeDef#
# WhatIfPointScenarioTypeDef definition
class WhatIfPointScenarioTypeDef(TypedDict):
Date: Union[datetime, str],
Value: float,
WhatIfRangeScenarioTypeDef#
# WhatIfRangeScenarioTypeDef definition
class WhatIfRangeScenarioTypeDef(TypedDict):
StartDate: Union[datetime, str],
EndDate: Union[datetime, str],
Value: float,
CustomSqlTypeDef#
# CustomSqlTypeDef definition
class CustomSqlTypeDef(TypedDict):
DataSourceArn: str,
Name: str,
SqlQuery: str,
Columns: NotRequired[Sequence[InputColumnTypeDef]], # (1)
RelationalTableTypeDef#
# RelationalTableTypeDef definition
class RelationalTableTypeDef(TypedDict):
DataSourceArn: str,
Name: str,
InputColumns: Sequence[InputColumnTypeDef], # (1)
Catalog: NotRequired[str],
Schema: NotRequired[str],
VisualInteractionOptionsTypeDef#
# VisualInteractionOptionsTypeDef definition
class VisualInteractionOptionsTypeDef(TypedDict):
VisualMenuOption: NotRequired[VisualMenuOptionTypeDef], # (1)
ContextMenuOption: NotRequired[ContextMenuOptionTypeDef], # (2)
SearchDashboardsRequestRequestTypeDef#
# SearchDashboardsRequestRequestTypeDef definition
class SearchDashboardsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DashboardSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListDashboardsResponseTypeDef#
# ListDashboardsResponseTypeDef definition
class ListDashboardsResponseTypeDef(TypedDict):
DashboardSummaryList: List[DashboardSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchDashboardsResponseTypeDef#
# SearchDashboardsResponseTypeDef definition
class SearchDashboardsResponseTypeDef(TypedDict):
DashboardSummaryList: List[DashboardSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDashboardVersionsResponseTypeDef#
# ListDashboardVersionsResponseTypeDef definition
class ListDashboardVersionsResponseTypeDef(TypedDict):
DashboardVersionSummaryList: List[DashboardVersionSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DashboardVisualPublishOptionsTypeDef#
# DashboardVisualPublishOptionsTypeDef definition
class DashboardVisualPublishOptionsTypeDef(TypedDict):
ExportHiddenFieldsOption: NotRequired[ExportHiddenFieldsOptionTypeDef], # (1)
TableInlineVisualizationTypeDef#
# TableInlineVisualizationTypeDef definition
class TableInlineVisualizationTypeDef(TypedDict):
DataBars: NotRequired[DataBarsOptionsTypeDef], # (1)
DataLabelTypeTypeDef#
# DataLabelTypeTypeDef definition
class DataLabelTypeTypeDef(TypedDict):
FieldLabelType: NotRequired[FieldLabelTypeTypeDef], # (1)
DataPathLabelType: NotRequired[DataPathLabelTypeTypeDef], # (2)
RangeEndsLabelType: NotRequired[RangeEndsLabelTypeTypeDef], # (3)
MinimumLabelType: NotRequired[MinimumLabelTypeTypeDef], # (4)
MaximumLabelType: NotRequired[MaximumLabelTypeTypeDef], # (5)
- See FieldLabelTypeTypeDef
- See DataPathLabelTypeTypeDef
- See RangeEndsLabelTypeTypeDef
- See MinimumLabelTypeTypeDef
- See MaximumLabelTypeTypeDef
DataPathValueTypeDef#
# DataPathValueTypeDef definition
class DataPathValueTypeDef(TypedDict):
FieldId: NotRequired[str],
FieldValue: NotRequired[str],
DataPathType: NotRequired[DataPathTypeTypeDef], # (1)
SearchDataSetsRequestRequestTypeDef#
# SearchDataSetsRequestRequestTypeDef definition
class SearchDataSetsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DataSetSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchDataSourcesRequestRequestTypeDef#
# SearchDataSourcesRequestRequestTypeDef definition
class SearchDataSourcesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DataSourceSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchDataSourcesResponseTypeDef#
# SearchDataSourcesResponseTypeDef definition
class SearchDataSourcesResponseTypeDef(TypedDict):
DataSourceSummaries: List[DataSourceSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TimeEqualityFilterTypeDef#
# TimeEqualityFilterTypeDef definition
class TimeEqualityFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
Value: NotRequired[Union[datetime, str]],
ParameterName: NotRequired[str],
TimeGranularity: NotRequired[TimeGranularityType], # (2)
RollingDate: NotRequired[RollingDateConfigurationTypeDef], # (3)
TimeRangeFilterValueTypeDef#
# TimeRangeFilterValueTypeDef definition
class TimeRangeFilterValueTypeDef(TypedDict):
StaticValue: NotRequired[Union[datetime, str]],
RollingDate: NotRequired[RollingDateConfigurationTypeDef], # (1)
Parameter: NotRequired[str],
DecimalDatasetParameterTypeDef#
# DecimalDatasetParameterTypeDef definition
class DecimalDatasetParameterTypeDef(TypedDict):
Id: str,
Name: str,
ValueType: DatasetParameterValueTypeType, # (1)
DefaultValues: NotRequired[DecimalDatasetParameterDefaultValuesTypeDef], # (2)
DescribeFolderPermissionsRequestDescribeFolderPermissionsPaginateTypeDef#
# DescribeFolderPermissionsRequestDescribeFolderPermissionsPaginateTypeDef definition
class DescribeFolderPermissionsRequestDescribeFolderPermissionsPaginateTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Namespace: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeFolderResolvedPermissionsRequestDescribeFolderResolvedPermissionsPaginateTypeDef#
# DescribeFolderResolvedPermissionsRequestDescribeFolderResolvedPermissionsPaginateTypeDef definition
class DescribeFolderResolvedPermissionsRequestDescribeFolderResolvedPermissionsPaginateTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
Namespace: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAnalysesRequestListAnalysesPaginateTypeDef#
# ListAnalysesRequestListAnalysesPaginateTypeDef definition
class ListAnalysesRequestListAnalysesPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAssetBundleExportJobsRequestListAssetBundleExportJobsPaginateTypeDef#
# ListAssetBundleExportJobsRequestListAssetBundleExportJobsPaginateTypeDef definition
class ListAssetBundleExportJobsRequestListAssetBundleExportJobsPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListAssetBundleImportJobsRequestListAssetBundleImportJobsPaginateTypeDef#
# ListAssetBundleImportJobsRequestListAssetBundleImportJobsPaginateTypeDef definition
class ListAssetBundleImportJobsRequestListAssetBundleImportJobsPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDashboardVersionsRequestListDashboardVersionsPaginateTypeDef#
# ListDashboardVersionsRequestListDashboardVersionsPaginateTypeDef definition
class ListDashboardVersionsRequestListDashboardVersionsPaginateTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDashboardsRequestListDashboardsPaginateTypeDef#
# ListDashboardsRequestListDashboardsPaginateTypeDef definition
class ListDashboardsRequestListDashboardsPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataSetsRequestListDataSetsPaginateTypeDef#
# ListDataSetsRequestListDataSetsPaginateTypeDef definition
class ListDataSetsRequestListDataSetsPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataSourcesRequestListDataSourcesPaginateTypeDef#
# ListDataSourcesRequestListDataSourcesPaginateTypeDef definition
class ListDataSourcesRequestListDataSourcesPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFolderMembersRequestListFolderMembersPaginateTypeDef#
# ListFolderMembersRequestListFolderMembersPaginateTypeDef definition
class ListFolderMembersRequestListFolderMembersPaginateTypeDef(TypedDict):
AwsAccountId: str,
FolderId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListFoldersRequestListFoldersPaginateTypeDef#
# ListFoldersRequestListFoldersPaginateTypeDef definition
class ListFoldersRequestListFoldersPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef#
# ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef definition
class ListGroupMembershipsRequestListGroupMembershipsPaginateTypeDef(TypedDict):
GroupName: str,
AwsAccountId: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListGroupsRequestListGroupsPaginateTypeDef#
# ListGroupsRequestListGroupsPaginateTypeDef definition
class ListGroupsRequestListGroupsPaginateTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIAMPolicyAssignmentsForUserRequestListIAMPolicyAssignmentsForUserPaginateTypeDef#
# ListIAMPolicyAssignmentsForUserRequestListIAMPolicyAssignmentsForUserPaginateTypeDef definition
class ListIAMPolicyAssignmentsForUserRequestListIAMPolicyAssignmentsForUserPaginateTypeDef(TypedDict):
AwsAccountId: str,
UserName: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListIAMPolicyAssignmentsRequestListIAMPolicyAssignmentsPaginateTypeDef#
# ListIAMPolicyAssignmentsRequestListIAMPolicyAssignmentsPaginateTypeDef definition
class ListIAMPolicyAssignmentsRequestListIAMPolicyAssignmentsPaginateTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
AssignmentStatus: NotRequired[AssignmentStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListIngestionsRequestListIngestionsPaginateTypeDef#
# ListIngestionsRequestListIngestionsPaginateTypeDef definition
class ListIngestionsRequestListIngestionsPaginateTypeDef(TypedDict):
DataSetId: str,
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListNamespacesRequestListNamespacesPaginateTypeDef#
# ListNamespacesRequestListNamespacesPaginateTypeDef definition
class ListNamespacesRequestListNamespacesPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRoleMembershipsRequestListRoleMembershipsPaginateTypeDef#
# ListRoleMembershipsRequestListRoleMembershipsPaginateTypeDef definition
class ListRoleMembershipsRequestListRoleMembershipsPaginateTypeDef(TypedDict):
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See RoleType
- See PaginatorConfigTypeDef
ListTemplateAliasesRequestListTemplateAliasesPaginateTypeDef#
# ListTemplateAliasesRequestListTemplateAliasesPaginateTypeDef definition
class ListTemplateAliasesRequestListTemplateAliasesPaginateTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTemplateVersionsRequestListTemplateVersionsPaginateTypeDef#
# ListTemplateVersionsRequestListTemplateVersionsPaginateTypeDef definition
class ListTemplateVersionsRequestListTemplateVersionsPaginateTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTemplatesRequestListTemplatesPaginateTypeDef#
# ListTemplatesRequestListTemplatesPaginateTypeDef definition
class ListTemplatesRequestListTemplatesPaginateTypeDef(TypedDict):
AwsAccountId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThemeVersionsRequestListThemeVersionsPaginateTypeDef#
# ListThemeVersionsRequestListThemeVersionsPaginateTypeDef definition
class ListThemeVersionsRequestListThemeVersionsPaginateTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListThemesRequestListThemesPaginateTypeDef#
# ListThemesRequestListThemesPaginateTypeDef definition
class ListThemesRequestListThemesPaginateTypeDef(TypedDict):
AwsAccountId: str,
Type: NotRequired[ThemeTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See ThemeTypeType
- See PaginatorConfigTypeDef
ListUserGroupsRequestListUserGroupsPaginateTypeDef#
# ListUserGroupsRequestListUserGroupsPaginateTypeDef definition
class ListUserGroupsRequestListUserGroupsPaginateTypeDef(TypedDict):
UserName: str,
AwsAccountId: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestListUsersPaginateTypeDef#
# ListUsersRequestListUsersPaginateTypeDef definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
SearchAnalysesRequestSearchAnalysesPaginateTypeDef#
# SearchAnalysesRequestSearchAnalysesPaginateTypeDef definition
class SearchAnalysesRequestSearchAnalysesPaginateTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[AnalysisSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchDashboardsRequestSearchDashboardsPaginateTypeDef#
# SearchDashboardsRequestSearchDashboardsPaginateTypeDef definition
class SearchDashboardsRequestSearchDashboardsPaginateTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DashboardSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchDataSetsRequestSearchDataSetsPaginateTypeDef#
# SearchDataSetsRequestSearchDataSetsPaginateTypeDef definition
class SearchDataSetsRequestSearchDataSetsPaginateTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DataSetSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
SearchDataSourcesRequestSearchDataSourcesPaginateTypeDef#
# SearchDataSourcesRequestSearchDataSourcesPaginateTypeDef definition
class SearchDataSourcesRequestSearchDataSourcesPaginateTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[DataSourceSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
DescribeFolderPermissionsResponsePaginatorTypeDef#
# DescribeFolderPermissionsResponsePaginatorTypeDef definition
class DescribeFolderPermissionsResponsePaginatorTypeDef(TypedDict):
Status: int,
FolderId: str,
Arn: str,
Permissions: List[ResourcePermissionPaginatorTypeDef], # (1)
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFolderResolvedPermissionsResponsePaginatorTypeDef#
# DescribeFolderResolvedPermissionsResponsePaginatorTypeDef definition
class DescribeFolderResolvedPermissionsResponsePaginatorTypeDef(TypedDict):
Status: int,
FolderId: str,
Arn: str,
Permissions: List[ResourcePermissionPaginatorTypeDef], # (1)
RequestId: str,
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeFolderResponseTypeDef#
# DescribeFolderResponseTypeDef definition
class DescribeFolderResponseTypeDef(TypedDict):
Status: int,
Folder: FolderTypeDef, # (1)
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See FolderTypeDef
- See ResponseMetadataTypeDef
DescribeIAMPolicyAssignmentResponseTypeDef#
# DescribeIAMPolicyAssignmentResponseTypeDef definition
class DescribeIAMPolicyAssignmentResponseTypeDef(TypedDict):
IAMPolicyAssignment: IAMPolicyAssignmentTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeTopicRefreshResponseTypeDef#
# DescribeTopicRefreshResponseTypeDef definition
class DescribeTopicRefreshResponseTypeDef(TypedDict):
RefreshDetails: TopicRefreshDetailsTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeUserResponseTypeDef#
# DescribeUserResponseTypeDef definition
class DescribeUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
ListUsersResponseTypeDef#
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
UserList: List[UserTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
RegisterUserResponseTypeDef#
# RegisterUserResponseTypeDef definition
class RegisterUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
UserInvitationUrl: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
User: UserTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
DisplayFormatOptionsTypeDef#
# DisplayFormatOptionsTypeDef definition
class DisplayFormatOptionsTypeDef(TypedDict):
UseBlankCellFormat: NotRequired[bool],
BlankCellFormat: NotRequired[str],
DateFormat: NotRequired[str],
DecimalSeparator: NotRequired[TopicNumericSeparatorSymbolType], # (1)
GroupingSeparator: NotRequired[str],
UseGrouping: NotRequired[bool],
FractionDigits: NotRequired[int],
Prefix: NotRequired[str],
Suffix: NotRequired[str],
UnitScaler: NotRequired[NumberScaleType], # (2)
NegativeFormat: NotRequired[NegativeFormatTypeDef], # (3)
CurrencySymbol: NotRequired[str],
DonutOptionsTypeDef#
# DonutOptionsTypeDef definition
class DonutOptionsTypeDef(TypedDict):
ArcOptions: NotRequired[ArcOptionsTypeDef], # (1)
DonutCenterOptions: NotRequired[DonutCenterOptionsTypeDef], # (2)
RelativeDatesFilterTypeDef#
# RelativeDatesFilterTypeDef definition
class RelativeDatesFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
AnchorDateConfiguration: AnchorDateConfigurationTypeDef, # (2)
TimeGranularity: TimeGranularityType, # (3)
RelativeDateType: RelativeDateTypeType, # (5)
NullOption: FilterNullOptionType, # (6)
MinimumGranularity: NotRequired[TimeGranularityType], # (3)
RelativeDateValue: NotRequired[int],
ParameterName: NotRequired[str],
ExcludePeriodConfiguration: NotRequired[ExcludePeriodConfigurationTypeDef], # (7)
- See ColumnIdentifierTypeDef
- See AnchorDateConfigurationTypeDef
- See TimeGranularityType
- See TimeGranularityType
- See RelativeDateTypeType
- See FilterNullOptionType
- See ExcludePeriodConfigurationTypeDef
FilterOperationTargetVisualsConfigurationTypeDef#
# FilterOperationTargetVisualsConfigurationTypeDef definition
class FilterOperationTargetVisualsConfigurationTypeDef(TypedDict):
SameSheetTargetVisualConfiguration: NotRequired[SameSheetTargetVisualConfigurationTypeDef], # (1)
SearchFoldersRequestRequestTypeDef#
# SearchFoldersRequestRequestTypeDef definition
class SearchFoldersRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[FolderSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchFoldersRequestSearchFoldersPaginateTypeDef#
# SearchFoldersRequestSearchFoldersPaginateTypeDef definition
class SearchFoldersRequestSearchFoldersPaginateTypeDef(TypedDict):
AwsAccountId: str,
Filters: Sequence[FolderSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListFoldersResponseTypeDef#
# ListFoldersResponseTypeDef definition
class ListFoldersResponseTypeDef(TypedDict):
Status: int,
FolderSummaryList: List[FolderSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchFoldersResponseTypeDef#
# SearchFoldersResponseTypeDef definition
class SearchFoldersResponseTypeDef(TypedDict):
Status: int,
FolderSummaryList: List[FolderSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
FontConfigurationTypeDef#
# FontConfigurationTypeDef definition
class FontConfigurationTypeDef(TypedDict):
FontSize: NotRequired[FontSizeTypeDef], # (1)
FontDecoration: NotRequired[FontDecorationType], # (2)
FontColor: NotRequired[str],
FontWeight: NotRequired[FontWeightTypeDef], # (3)
FontStyle: NotRequired[FontStyleType], # (4)
- See FontSizeTypeDef
- See FontDecorationType
- See FontWeightTypeDef
- See FontStyleType
TypographyTypeDef#
# TypographyTypeDef definition
class TypographyTypeDef(TypedDict):
FontFamilies: NotRequired[Sequence[FontTypeDef]], # (1)
- See FontTypeDef
FreeFormLayoutCanvasSizeOptionsTypeDef#
# FreeFormLayoutCanvasSizeOptionsTypeDef definition
class FreeFormLayoutCanvasSizeOptionsTypeDef(TypedDict):
ScreenCanvasSizeOptions: NotRequired[FreeFormLayoutScreenCanvasSizeOptionsTypeDef], # (1)
SnapshotAnonymousUserTypeDef#
# SnapshotAnonymousUserTypeDef definition
class SnapshotAnonymousUserTypeDef(TypedDict):
RowLevelPermissionTags: NotRequired[Sequence[SessionTagTypeDef]], # (1)
GeospatialWindowOptionsTypeDef#
# GeospatialWindowOptionsTypeDef definition
class GeospatialWindowOptionsTypeDef(TypedDict):
Bounds: NotRequired[GeospatialCoordinateBoundsTypeDef], # (1)
MapZoomMode: NotRequired[MapZoomModeType], # (2)
GeospatialHeatmapColorScaleTypeDef#
# GeospatialHeatmapColorScaleTypeDef definition
class GeospatialHeatmapColorScaleTypeDef(TypedDict):
Colors: NotRequired[Sequence[GeospatialHeatmapDataColorTypeDef]], # (1)
TableSideBorderOptionsTypeDef#
# TableSideBorderOptionsTypeDef definition
class TableSideBorderOptionsTypeDef(TypedDict):
InnerVertical: NotRequired[TableBorderOptionsTypeDef], # (1)
InnerHorizontal: NotRequired[TableBorderOptionsTypeDef], # (1)
Left: NotRequired[TableBorderOptionsTypeDef], # (1)
Right: NotRequired[TableBorderOptionsTypeDef], # (1)
Top: NotRequired[TableBorderOptionsTypeDef], # (1)
Bottom: NotRequired[TableBorderOptionsTypeDef], # (1)
- See TableBorderOptionsTypeDef
- See TableBorderOptionsTypeDef
- See TableBorderOptionsTypeDef
- See TableBorderOptionsTypeDef
- See TableBorderOptionsTypeDef
- See TableBorderOptionsTypeDef
GradientColorTypeDef#
# GradientColorTypeDef definition
class GradientColorTypeDef(TypedDict):
Stops: NotRequired[Sequence[GradientStopTypeDef]], # (1)
GridLayoutCanvasSizeOptionsTypeDef#
# GridLayoutCanvasSizeOptionsTypeDef definition
class GridLayoutCanvasSizeOptionsTypeDef(TypedDict):
ScreenCanvasSizeOptions: NotRequired[GridLayoutScreenCanvasSizeOptionsTypeDef], # (1)
SearchGroupsRequestRequestTypeDef#
# SearchGroupsRequestRequestTypeDef definition
class SearchGroupsRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
Filters: Sequence[GroupSearchFilterTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
SearchGroupsRequestSearchGroupsPaginateTypeDef#
# SearchGroupsRequestSearchGroupsPaginateTypeDef definition
class SearchGroupsRequestSearchGroupsPaginateTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
Filters: Sequence[GroupSearchFilterTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListIAMPolicyAssignmentsResponseTypeDef#
# ListIAMPolicyAssignmentsResponseTypeDef definition
class ListIAMPolicyAssignmentsResponseTypeDef(TypedDict):
IAMPolicyAssignments: List[IAMPolicyAssignmentSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
IncrementalRefreshTypeDef#
# IncrementalRefreshTypeDef definition
class IncrementalRefreshTypeDef(TypedDict):
LookbackWindow: LookbackWindowTypeDef, # (1)
IngestionTypeDef#
# IngestionTypeDef definition
class IngestionTypeDef(TypedDict):
Arn: str,
IngestionStatus: IngestionStatusType, # (1)
CreatedTime: datetime,
IngestionId: NotRequired[str],
ErrorInfo: NotRequired[ErrorInfoTypeDef], # (2)
RowInfo: NotRequired[RowInfoTypeDef], # (3)
QueueInfo: NotRequired[QueueInfoTypeDef], # (4)
IngestionTimeInSeconds: NotRequired[int],
IngestionSizeInBytes: NotRequired[int],
RequestSource: NotRequired[IngestionRequestSourceType], # (5)
RequestType: NotRequired[IngestionRequestTypeType], # (6)
- See IngestionStatusType
- See ErrorInfoTypeDef
- See RowInfoTypeDef
- See QueueInfoTypeDef
- See IngestionRequestSourceType
- See IngestionRequestTypeType
IntegerDatasetParameterTypeDef#
# IntegerDatasetParameterTypeDef definition
class IntegerDatasetParameterTypeDef(TypedDict):
Id: str,
Name: str,
ValueType: DatasetParameterValueTypeType, # (1)
DefaultValues: NotRequired[IntegerDatasetParameterDefaultValuesTypeDef], # (2)
JoinInstructionTypeDef#
# JoinInstructionTypeDef definition
class JoinInstructionTypeDef(TypedDict):
LeftOperand: str,
RightOperand: str,
Type: JoinTypeType, # (3)
OnClause: str,
LeftJoinKeyProperties: NotRequired[JoinKeyPropertiesTypeDef], # (1)
RightJoinKeyProperties: NotRequired[JoinKeyPropertiesTypeDef], # (1)
KPIVisualLayoutOptionsTypeDef#
# KPIVisualLayoutOptionsTypeDef definition
class KPIVisualLayoutOptionsTypeDef(TypedDict):
StandardLayout: NotRequired[KPIVisualStandardLayoutTypeDef], # (1)
LineChartDefaultSeriesSettingsTypeDef#
# LineChartDefaultSeriesSettingsTypeDef definition
class LineChartDefaultSeriesSettingsTypeDef(TypedDict):
AxisBinding: NotRequired[AxisBindingType], # (1)
LineStyleSettings: NotRequired[LineChartLineStyleSettingsTypeDef], # (2)
MarkerStyleSettings: NotRequired[LineChartMarkerStyleSettingsTypeDef], # (3)
LineChartSeriesSettingsTypeDef#
# LineChartSeriesSettingsTypeDef definition
class LineChartSeriesSettingsTypeDef(TypedDict):
LineStyleSettings: NotRequired[LineChartLineStyleSettingsTypeDef], # (1)
MarkerStyleSettings: NotRequired[LineChartMarkerStyleSettingsTypeDef], # (2)
ListFolderMembersResponseTypeDef#
# ListFolderMembersResponseTypeDef definition
class ListFolderMembersResponseTypeDef(TypedDict):
Status: int,
FolderMemberList: List[MemberIdArnPairTypeDef], # (1)
NextToken: str,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTemplateVersionsResponseTypeDef#
# ListTemplateVersionsResponseTypeDef definition
class ListTemplateVersionsResponseTypeDef(TypedDict):
TemplateVersionSummaryList: List[TemplateVersionSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTemplatesResponseTypeDef#
# ListTemplatesResponseTypeDef definition
class ListTemplatesResponseTypeDef(TypedDict):
TemplateSummaryList: List[TemplateSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThemeVersionsResponseTypeDef#
# ListThemeVersionsResponseTypeDef definition
class ListThemeVersionsResponseTypeDef(TypedDict):
ThemeVersionSummaryList: List[ThemeVersionSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListThemesResponseTypeDef#
# ListThemesResponseTypeDef definition
class ListThemesResponseTypeDef(TypedDict):
ThemeSummaryList: List[ThemeSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTopicsResponseTypeDef#
# ListTopicsResponseTypeDef definition
class ListTopicsResponseTypeDef(TypedDict):
TopicsSummaries: List[TopicSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VisualSubtitleLabelOptionsTypeDef#
# VisualSubtitleLabelOptionsTypeDef definition
class VisualSubtitleLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
FormatText: NotRequired[LongFormatTextTypeDef], # (2)
- See VisibilityType
- See LongFormatTextTypeDef
S3ParametersTypeDef#
# S3ParametersTypeDef definition
class S3ParametersTypeDef(TypedDict):
ManifestFileLocation: ManifestFileLocationTypeDef, # (1)
RoleArn: NotRequired[str],
TileLayoutStyleTypeDef#
# TileLayoutStyleTypeDef definition
class TileLayoutStyleTypeDef(TypedDict):
Gutter: NotRequired[GutterStyleTypeDef], # (1)
Margin: NotRequired[MarginStyleTypeDef], # (2)
- See GutterStyleTypeDef
- See MarginStyleTypeDef
NamedEntityDefinitionTypeDef#
# NamedEntityDefinitionTypeDef definition
class NamedEntityDefinitionTypeDef(TypedDict):
FieldName: NotRequired[str],
PropertyName: NotRequired[str],
PropertyRole: NotRequired[PropertyRoleType], # (1)
PropertyUsage: NotRequired[PropertyUsageType], # (2)
Metric: NotRequired[NamedEntityDefinitionMetricTypeDef], # (3)
NamespaceInfoV2TypeDef#
# NamespaceInfoV2TypeDef definition
class NamespaceInfoV2TypeDef(TypedDict):
Name: NotRequired[str],
Arn: NotRequired[str],
CapacityRegion: NotRequired[str],
CreationStatus: NotRequired[NamespaceStatusType], # (1)
IdentityStore: NotRequired[IdentityStoreType], # (2)
NamespaceError: NotRequired[NamespaceErrorTypeDef], # (3)
VPCConnectionSummaryTypeDef#
# VPCConnectionSummaryTypeDef definition
class VPCConnectionSummaryTypeDef(TypedDict):
VPCConnectionId: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
VPCId: NotRequired[str],
SecurityGroupIds: NotRequired[List[str]],
DnsResolvers: NotRequired[List[str]],
Status: NotRequired[VPCConnectionResourceStatusType], # (1)
AvailabilityStatus: NotRequired[VPCConnectionAvailabilityStatusType], # (2)
NetworkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]], # (3)
RoleArn: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
- See VPCConnectionResourceStatusType
- See VPCConnectionAvailabilityStatusType
- See NetworkInterfaceTypeDef
VPCConnectionTypeDef#
# VPCConnectionTypeDef definition
class VPCConnectionTypeDef(TypedDict):
VPCConnectionId: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
VPCId: NotRequired[str],
SecurityGroupIds: NotRequired[List[str]],
DnsResolvers: NotRequired[List[str]],
Status: NotRequired[VPCConnectionResourceStatusType], # (1)
AvailabilityStatus: NotRequired[VPCConnectionAvailabilityStatusType], # (2)
NetworkInterfaces: NotRequired[List[NetworkInterfaceTypeDef]], # (3)
RoleArn: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
- See VPCConnectionResourceStatusType
- See VPCConnectionAvailabilityStatusType
- See NetworkInterfaceTypeDef
NumericSeparatorConfigurationTypeDef#
# NumericSeparatorConfigurationTypeDef definition
class NumericSeparatorConfigurationTypeDef(TypedDict):
DecimalSeparator: NotRequired[NumericSeparatorSymbolType], # (1)
ThousandsSeparator: NotRequired[ThousandSeparatorOptionsTypeDef], # (2)
NumericalAggregationFunctionTypeDef#
# NumericalAggregationFunctionTypeDef definition
class NumericalAggregationFunctionTypeDef(TypedDict):
SimpleNumericalAggregation: NotRequired[SimpleNumericalAggregationFunctionType], # (1)
PercentileAggregation: NotRequired[PercentileAggregationTypeDef], # (2)
VisibleRangeOptionsTypeDef#
# VisibleRangeOptionsTypeDef definition
class VisibleRangeOptionsTypeDef(TypedDict):
PercentRange: NotRequired[PercentVisibleRangeTypeDef], # (1)
RadarChartSeriesSettingsTypeDef#
# RadarChartSeriesSettingsTypeDef definition
class RadarChartSeriesSettingsTypeDef(TypedDict):
AreaStyleSettings: NotRequired[RadarChartAreaStyleSettingsTypeDef], # (1)
TopicRangeFilterConstantTypeDef#
# TopicRangeFilterConstantTypeDef definition
class TopicRangeFilterConstantTypeDef(TypedDict):
ConstantType: NotRequired[ConstantTypeType], # (1)
RangeConstant: NotRequired[RangeConstantTypeDef], # (2)
- See ConstantTypeType
- See RangeConstantTypeDef
RedshiftParametersPaginatorTypeDef#
# RedshiftParametersPaginatorTypeDef definition
class RedshiftParametersPaginatorTypeDef(TypedDict):
Database: str,
Host: NotRequired[str],
Port: NotRequired[int],
ClusterId: NotRequired[str],
IAMParameters: NotRequired[RedshiftIAMParametersPaginatorTypeDef], # (1)
IdentityCenterConfiguration: NotRequired[IdentityCenterConfigurationTypeDef], # (2)
RedshiftParametersTypeDef#
# RedshiftParametersTypeDef definition
class RedshiftParametersTypeDef(TypedDict):
Database: str,
Host: NotRequired[str],
Port: NotRequired[int],
ClusterId: NotRequired[str],
IAMParameters: NotRequired[RedshiftIAMParametersTypeDef], # (1)
IdentityCenterConfiguration: NotRequired[IdentityCenterConfigurationTypeDef], # (2)
RefreshFrequencyTypeDef#
# RefreshFrequencyTypeDef definition
class RefreshFrequencyTypeDef(TypedDict):
Interval: RefreshIntervalType, # (1)
RefreshOnDay: NotRequired[ScheduleRefreshOnEntityTypeDef], # (2)
Timezone: NotRequired[str],
TimeOfTheDay: NotRequired[str],
RegisteredUserConsoleFeatureConfigurationsTypeDef#
# RegisteredUserConsoleFeatureConfigurationsTypeDef definition
class RegisteredUserConsoleFeatureConfigurationsTypeDef(TypedDict):
StatePersistence: NotRequired[StatePersistenceConfigurationsTypeDef], # (1)
RegisteredUserDashboardFeatureConfigurationsTypeDef#
# RegisteredUserDashboardFeatureConfigurationsTypeDef definition
class RegisteredUserDashboardFeatureConfigurationsTypeDef(TypedDict):
StatePersistence: NotRequired[StatePersistenceConfigurationsTypeDef], # (1)
Bookmarks: NotRequired[BookmarksConfigurationsTypeDef], # (2)
RowLevelPermissionTagConfigurationTypeDef#
# RowLevelPermissionTagConfigurationTypeDef definition
class RowLevelPermissionTagConfigurationTypeDef(TypedDict):
TagRules: Sequence[RowLevelPermissionTagRuleTypeDef], # (2)
Status: NotRequired[StatusType], # (1)
TagRuleConfigurations: NotRequired[Sequence[Sequence[str]]],
SnapshotS3DestinationConfigurationTypeDef#
# SnapshotS3DestinationConfigurationTypeDef definition
class SnapshotS3DestinationConfigurationTypeDef(TypedDict):
BucketConfiguration: S3BucketConfigurationTypeDef, # (1)
S3SourceTypeDef#
# S3SourceTypeDef definition
class S3SourceTypeDef(TypedDict):
DataSourceArn: str,
InputColumns: Sequence[InputColumnTypeDef], # (2)
UploadSettings: NotRequired[UploadSettingsTypeDef], # (1)
SectionPageBreakConfigurationTypeDef#
# SectionPageBreakConfigurationTypeDef definition
class SectionPageBreakConfigurationTypeDef(TypedDict):
After: NotRequired[SectionAfterPageBreakTypeDef], # (1)
SectionBasedLayoutPaperCanvasSizeOptionsTypeDef#
# SectionBasedLayoutPaperCanvasSizeOptionsTypeDef definition
class SectionBasedLayoutPaperCanvasSizeOptionsTypeDef(TypedDict):
PaperSize: NotRequired[PaperSizeType], # (1)
PaperOrientation: NotRequired[PaperOrientationType], # (2)
PaperMargin: NotRequired[SpacingTypeDef], # (3)
- See PaperSizeType
- See PaperOrientationType
- See SpacingTypeDef
SectionStyleTypeDef#
# SectionStyleTypeDef definition
class SectionStyleTypeDef(TypedDict):
Height: NotRequired[str],
Padding: NotRequired[SpacingTypeDef], # (1)
- See SpacingTypeDef
SelectedSheetsFilterScopeConfigurationTypeDef#
# SelectedSheetsFilterScopeConfigurationTypeDef definition
class SelectedSheetsFilterScopeConfigurationTypeDef(TypedDict):
SheetVisualScopingConfigurations: NotRequired[Sequence[SheetVisualScopingConfigurationTypeDef]], # (1)
SheetElementRenderingRuleTypeDef#
# SheetElementRenderingRuleTypeDef definition
class SheetElementRenderingRuleTypeDef(TypedDict):
Expression: str,
ConfigurationOverrides: SheetElementConfigurationOverridesTypeDef, # (1)
VisualTitleLabelOptionsTypeDef#
# VisualTitleLabelOptionsTypeDef definition
class VisualTitleLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
FormatText: NotRequired[ShortFormatTextTypeDef], # (2)
- See VisibilityType
- See ShortFormatTextTypeDef
SingleAxisOptionsTypeDef#
# SingleAxisOptionsTypeDef definition
class SingleAxisOptionsTypeDef(TypedDict):
YAxisOptions: NotRequired[YAxisOptionsTypeDef], # (1)
SnapshotUserConfigurationRedactedTypeDef#
# SnapshotUserConfigurationRedactedTypeDef definition
class SnapshotUserConfigurationRedactedTypeDef(TypedDict):
AnonymousUsers: NotRequired[List[SnapshotAnonymousUserRedactedTypeDef]], # (1)
SnapshotFileTypeDef#
# SnapshotFileTypeDef definition
class SnapshotFileTypeDef(TypedDict):
SheetSelections: List[SnapshotFileSheetSelectionTypeDef], # (1)
FormatType: SnapshotFileFormatTypeType, # (2)
StringDatasetParameterTypeDef#
# StringDatasetParameterTypeDef definition
class StringDatasetParameterTypeDef(TypedDict):
Id: str,
Name: str,
ValueType: DatasetParameterValueTypeType, # (1)
DefaultValues: NotRequired[StringDatasetParameterDefaultValuesTypeDef], # (2)
TableFieldImageConfigurationTypeDef#
# TableFieldImageConfigurationTypeDef definition
class TableFieldImageConfigurationTypeDef(TypedDict):
SizingOptions: NotRequired[TableCellImageSizingConfigurationTypeDef], # (1)
TopicNumericEqualityFilterTypeDef#
# TopicNumericEqualityFilterTypeDef definition
class TopicNumericEqualityFilterTypeDef(TypedDict):
Constant: NotRequired[TopicSingularFilterConstantTypeDef], # (1)
Aggregation: NotRequired[NamedFilterAggTypeType], # (2)
TopicRelativeDateFilterTypeDef#
# TopicRelativeDateFilterTypeDef definition
class TopicRelativeDateFilterTypeDef(TypedDict):
TimeGranularity: NotRequired[TopicTimeGranularityType], # (1)
RelativeDateFilterFunction: NotRequired[TopicRelativeDateFilterFunctionType], # (2)
Constant: NotRequired[TopicSingularFilterConstantTypeDef], # (3)
- See TopicTimeGranularityType
- See TopicRelativeDateFilterFunctionType
- See TopicSingularFilterConstantTypeDef
TotalAggregationOptionTypeDef#
# TotalAggregationOptionTypeDef definition
class TotalAggregationOptionTypeDef(TypedDict):
FieldId: str,
TotalAggregationFunction: TotalAggregationFunctionTypeDef, # (1)
WaterfallChartColorConfigurationTypeDef#
# WaterfallChartColorConfigurationTypeDef definition
class WaterfallChartColorConfigurationTypeDef(TypedDict):
GroupColorConfiguration: NotRequired[WaterfallChartGroupColorConfigurationTypeDef], # (1)
CascadingControlConfigurationTypeDef#
# CascadingControlConfigurationTypeDef definition
class CascadingControlConfigurationTypeDef(TypedDict):
SourceControls: NotRequired[Sequence[CascadingControlSourceTypeDef]], # (1)
DateTimeDefaultValuesTypeDef#
# DateTimeDefaultValuesTypeDef definition
class DateTimeDefaultValuesTypeDef(TypedDict):
DynamicValue: NotRequired[DynamicDefaultValueTypeDef], # (1)
StaticValues: NotRequired[Sequence[Union[datetime, str]]],
RollingDate: NotRequired[RollingDateConfigurationTypeDef], # (2)
DecimalDefaultValuesTypeDef#
# DecimalDefaultValuesTypeDef definition
class DecimalDefaultValuesTypeDef(TypedDict):
DynamicValue: NotRequired[DynamicDefaultValueTypeDef], # (1)
StaticValues: NotRequired[Sequence[float]],
IntegerDefaultValuesTypeDef#
# IntegerDefaultValuesTypeDef definition
class IntegerDefaultValuesTypeDef(TypedDict):
DynamicValue: NotRequired[DynamicDefaultValueTypeDef], # (1)
StaticValues: NotRequired[Sequence[int]],
StringDefaultValuesTypeDef#
# StringDefaultValuesTypeDef definition
class StringDefaultValuesTypeDef(TypedDict):
DynamicValue: NotRequired[DynamicDefaultValueTypeDef], # (1)
StaticValues: NotRequired[Sequence[str]],
AnalysisTypeDef#
# AnalysisTypeDef definition
class AnalysisTypeDef(TypedDict):
AnalysisId: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Status: NotRequired[ResourceStatusType], # (1)
Errors: NotRequired[List[AnalysisErrorTypeDef]], # (2)
DataSetArns: NotRequired[List[str]],
ThemeArn: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
Sheets: NotRequired[List[SheetTypeDef]], # (3)
- See ResourceStatusType
- See AnalysisErrorTypeDef
- See SheetTypeDef
DashboardVersionTypeDef#
# DashboardVersionTypeDef definition
class DashboardVersionTypeDef(TypedDict):
CreatedTime: NotRequired[datetime],
Errors: NotRequired[List[DashboardErrorTypeDef]], # (1)
VersionNumber: NotRequired[int],
Status: NotRequired[ResourceStatusType], # (2)
Arn: NotRequired[str],
SourceEntityArn: NotRequired[str],
DataSetArns: NotRequired[List[str]],
Description: NotRequired[str],
ThemeArn: NotRequired[str],
Sheets: NotRequired[List[SheetTypeDef]], # (3)
- See DashboardErrorTypeDef
- See ResourceStatusType
- See SheetTypeDef
AnalysisSourceEntityTypeDef#
# AnalysisSourceEntityTypeDef definition
class AnalysisSourceEntityTypeDef(TypedDict):
SourceTemplate: NotRequired[AnalysisSourceTemplateTypeDef], # (1)
DashboardSourceEntityTypeDef#
# DashboardSourceEntityTypeDef definition
class DashboardSourceEntityTypeDef(TypedDict):
SourceTemplate: NotRequired[DashboardSourceTemplateTypeDef], # (1)
TemplateSourceEntityTypeDef#
# TemplateSourceEntityTypeDef definition
class TemplateSourceEntityTypeDef(TypedDict):
SourceAnalysis: NotRequired[TemplateSourceAnalysisTypeDef], # (1)
SourceTemplate: NotRequired[TemplateSourceTemplateTypeDef], # (2)
AnonymousUserEmbeddingExperienceConfigurationTypeDef#
# AnonymousUserEmbeddingExperienceConfigurationTypeDef definition
class AnonymousUserEmbeddingExperienceConfigurationTypeDef(TypedDict):
Dashboard: NotRequired[AnonymousUserDashboardEmbeddingConfigurationTypeDef], # (1)
DashboardVisual: NotRequired[AnonymousUserDashboardVisualEmbeddingConfigurationTypeDef], # (2)
QSearchBar: NotRequired[AnonymousUserQSearchBarEmbeddingConfigurationTypeDef], # (3)
- See AnonymousUserDashboardEmbeddingConfigurationTypeDef
- See AnonymousUserDashboardVisualEmbeddingConfigurationTypeDef
- See AnonymousUserQSearchBarEmbeddingConfigurationTypeDef
DescribeAssetBundleExportJobResponseTypeDef#
# DescribeAssetBundleExportJobResponseTypeDef definition
class DescribeAssetBundleExportJobResponseTypeDef(TypedDict):
JobStatus: AssetBundleExportJobStatusType, # (1)
DownloadUrl: str,
Errors: List[AssetBundleExportJobErrorTypeDef], # (2)
Arn: str,
CreatedTime: datetime,
AssetBundleExportJobId: str,
AwsAccountId: str,
ResourceArns: List[str],
IncludeAllDependencies: bool,
ExportFormat: AssetBundleExportFormatType, # (3)
CloudFormationOverridePropertyConfiguration: AssetBundleCloudFormationOverridePropertyConfigurationTypeDef, # (4)
RequestId: str,
Status: int,
IncludePermissions: bool,
IncludeTags: bool,
ValidationStrategy: AssetBundleExportJobValidationStrategyTypeDef, # (5)
Warnings: List[AssetBundleExportJobWarningTypeDef], # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (7)
- See AssetBundleExportJobStatusType
- See AssetBundleExportJobErrorTypeDef
- See AssetBundleExportFormatType
- See AssetBundleCloudFormationOverridePropertyConfigurationTypeDef
- See AssetBundleExportJobValidationStrategyTypeDef
- See AssetBundleExportJobWarningTypeDef
- See ResponseMetadataTypeDef
StartAssetBundleExportJobRequestRequestTypeDef#
# StartAssetBundleExportJobRequestRequestTypeDef definition
class StartAssetBundleExportJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssetBundleExportJobId: str,
ResourceArns: Sequence[str],
ExportFormat: AssetBundleExportFormatType, # (1)
IncludeAllDependencies: NotRequired[bool],
CloudFormationOverridePropertyConfiguration: NotRequired[AssetBundleCloudFormationOverridePropertyConfigurationTypeDef], # (2)
IncludePermissions: NotRequired[bool],
IncludeTags: NotRequired[bool],
ValidationStrategy: NotRequired[AssetBundleExportJobValidationStrategyTypeDef], # (3)
- See AssetBundleExportFormatType
- See AssetBundleCloudFormationOverridePropertyConfigurationTypeDef
- See AssetBundleExportJobValidationStrategyTypeDef
AssetBundleImportJobDashboardOverridePermissionsTypeDef#
# AssetBundleImportJobDashboardOverridePermissionsTypeDef definition
class AssetBundleImportJobDashboardOverridePermissionsTypeDef(TypedDict):
DashboardIds: List[str],
Permissions: NotRequired[AssetBundleResourcePermissionsTypeDef], # (1)
LinkSharingConfiguration: NotRequired[AssetBundleResourceLinkSharingConfigurationTypeDef], # (2)
AssetBundleImportJobOverrideTagsTypeDef#
# AssetBundleImportJobOverrideTagsTypeDef definition
class AssetBundleImportJobOverrideTagsTypeDef(TypedDict):
VPCConnections: NotRequired[List[AssetBundleImportJobVPCConnectionOverrideTagsTypeDef]], # (1)
DataSources: NotRequired[List[AssetBundleImportJobDataSourceOverrideTagsTypeDef]], # (2)
DataSets: NotRequired[List[AssetBundleImportJobDataSetOverrideTagsTypeDef]], # (3)
Themes: NotRequired[List[AssetBundleImportJobThemeOverrideTagsTypeDef]], # (4)
Analyses: NotRequired[List[AssetBundleImportJobAnalysisOverrideTagsTypeDef]], # (5)
Dashboards: NotRequired[List[AssetBundleImportJobDashboardOverrideTagsTypeDef]], # (6)
- See AssetBundleImportJobVPCConnectionOverrideTagsTypeDef
- See AssetBundleImportJobDataSourceOverrideTagsTypeDef
- See AssetBundleImportJobDataSetOverrideTagsTypeDef
- See AssetBundleImportJobThemeOverrideTagsTypeDef
- See AssetBundleImportJobAnalysisOverrideTagsTypeDef
- See AssetBundleImportJobDashboardOverrideTagsTypeDef
NumericAxisOptionsTypeDef#
# NumericAxisOptionsTypeDef definition
class NumericAxisOptionsTypeDef(TypedDict):
Scale: NotRequired[AxisScaleTypeDef], # (1)
Range: NotRequired[AxisDisplayRangeTypeDef], # (2)
CategoryFilterTypeDef#
# CategoryFilterTypeDef definition
class CategoryFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
Configuration: CategoryFilterConfigurationTypeDef, # (2)
ClusterMarkerConfigurationTypeDef#
# ClusterMarkerConfigurationTypeDef definition
class ClusterMarkerConfigurationTypeDef(TypedDict):
ClusterMarker: NotRequired[ClusterMarkerTypeDef], # (1)
TopicCategoryFilterTypeDef#
# TopicCategoryFilterTypeDef definition
class TopicCategoryFilterTypeDef(TypedDict):
CategoryFilterFunction: NotRequired[CategoryFilterFunctionType], # (1)
CategoryFilterType: NotRequired[CategoryFilterTypeType], # (2)
Constant: NotRequired[TopicCategoryFilterConstantTypeDef], # (3)
Inverse: NotRequired[bool],
TagColumnOperationTypeDef#
# TagColumnOperationTypeDef definition
class TagColumnOperationTypeDef(TypedDict):
ColumnName: str,
Tags: Sequence[ColumnTagTypeDef], # (1)
- See ColumnTagTypeDef
DataSetConfigurationTypeDef#
# DataSetConfigurationTypeDef definition
class DataSetConfigurationTypeDef(TypedDict):
Placeholder: NotRequired[str],
DataSetSchema: NotRequired[DataSetSchemaTypeDef], # (1)
ColumnGroupSchemaList: NotRequired[Sequence[ColumnGroupSchemaTypeDef]], # (2)
ConditionalFormattingIconTypeDef#
# ConditionalFormattingIconTypeDef definition
class ConditionalFormattingIconTypeDef(TypedDict):
IconSet: NotRequired[ConditionalFormattingIconSetTypeDef], # (1)
CustomCondition: NotRequired[ConditionalFormattingCustomIconConditionTypeDef], # (2)
DescribeDashboardPermissionsResponseTypeDef#
# DescribeDashboardPermissionsResponseTypeDef definition
class DescribeDashboardPermissionsResponseTypeDef(TypedDict):
DashboardId: str,
DashboardArn: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
Status: int,
RequestId: str,
LinkSharingConfiguration: LinkSharingConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateDashboardPermissionsResponseTypeDef#
# UpdateDashboardPermissionsResponseTypeDef definition
class UpdateDashboardPermissionsResponseTypeDef(TypedDict):
DashboardArn: str,
DashboardId: str,
Permissions: List[ResourcePermissionTypeDef], # (1)
RequestId: str,
Status: int,
LinkSharingConfiguration: LinkSharingConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ListDataSetsResponseTypeDef#
# ListDataSetsResponseTypeDef definition
class ListDataSetsResponseTypeDef(TypedDict):
DataSetSummaries: List[DataSetSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SearchDataSetsResponseTypeDef#
# SearchDataSetsResponseTypeDef definition
class SearchDataSetsResponseTypeDef(TypedDict):
DataSetSummaries: List[DataSetSummaryTypeDef], # (1)
NextToken: str,
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomValuesConfigurationTypeDef#
# CustomValuesConfigurationTypeDef definition
class CustomValuesConfigurationTypeDef(TypedDict):
CustomValues: CustomParameterValuesTypeDef, # (1)
IncludeNullValue: NotRequired[bool],
DateTimeDatasetParameterTypeDef#
# DateTimeDatasetParameterTypeDef definition
class DateTimeDatasetParameterTypeDef(TypedDict):
Id: str,
Name: str,
ValueType: DatasetParameterValueTypeType, # (1)
TimeGranularity: NotRequired[TimeGranularityType], # (2)
DefaultValues: NotRequired[DateTimeDatasetParameterDefaultValuesTypeDef], # (3)
- See DatasetParameterValueTypeType
- See TimeGranularityType
- See DateTimeDatasetParameterDefaultValuesTypeDef
ParametersTypeDef#
# ParametersTypeDef definition
class ParametersTypeDef(TypedDict):
StringParameters: NotRequired[Sequence[StringParameterTypeDef]], # (1)
IntegerParameters: NotRequired[Sequence[IntegerParameterTypeDef]], # (2)
DecimalParameters: NotRequired[Sequence[DecimalParameterTypeDef]], # (3)
DateTimeParameters: NotRequired[Sequence[DateTimeParameterTypeDef]], # (4)
- See StringParameterTypeDef
- See IntegerParameterTypeDef
- See DecimalParameterTypeDef
- See DateTimeParameterTypeDef
OverrideDatasetParameterOperationTypeDef#
# OverrideDatasetParameterOperationTypeDef definition
class OverrideDatasetParameterOperationTypeDef(TypedDict):
ParameterName: str,
NewParameterName: NotRequired[str],
NewDefaultValues: NotRequired[NewDefaultValuesTypeDef], # (1)
DrillDownFilterTypeDef#
# DrillDownFilterTypeDef definition
class DrillDownFilterTypeDef(TypedDict):
NumericEqualityFilter: NotRequired[NumericEqualityDrillDownFilterTypeDef], # (1)
CategoryFilter: NotRequired[CategoryDrillDownFilterTypeDef], # (2)
TimeRangeFilter: NotRequired[TimeRangeDrillDownFilterTypeDef], # (3)
- See NumericEqualityDrillDownFilterTypeDef
- See CategoryDrillDownFilterTypeDef
- See TimeRangeDrillDownFilterTypeDef
CreateTopicRefreshScheduleRequestRequestTypeDef#
# CreateTopicRefreshScheduleRequestRequestTypeDef definition
class CreateTopicRefreshScheduleRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DatasetArn: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
DatasetName: NotRequired[str],
DescribeTopicRefreshScheduleResponseTypeDef#
# DescribeTopicRefreshScheduleResponseTypeDef definition
class DescribeTopicRefreshScheduleResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
DatasetArn: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TopicRefreshScheduleSummaryTypeDef#
# TopicRefreshScheduleSummaryTypeDef definition
class TopicRefreshScheduleSummaryTypeDef(TypedDict):
DatasetId: NotRequired[str],
DatasetArn: NotRequired[str],
DatasetName: NotRequired[str],
RefreshSchedule: NotRequired[TopicRefreshScheduleTypeDef], # (1)
UpdateTopicRefreshScheduleRequestRequestTypeDef#
# UpdateTopicRefreshScheduleRequestRequestTypeDef definition
class UpdateTopicRefreshScheduleRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
DatasetId: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
ForecastScenarioTypeDef#
# ForecastScenarioTypeDef definition
class ForecastScenarioTypeDef(TypedDict):
WhatIfPointScenario: NotRequired[WhatIfPointScenarioTypeDef], # (1)
WhatIfRangeScenario: NotRequired[WhatIfRangeScenarioTypeDef], # (2)
CustomContentConfigurationTypeDef#
# CustomContentConfigurationTypeDef definition
class CustomContentConfigurationTypeDef(TypedDict):
ContentUrl: NotRequired[str],
ContentType: NotRequired[CustomContentTypeType], # (1)
ImageScaling: NotRequired[CustomContentImageScalingConfigurationType], # (2)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (3)
- See CustomContentTypeType
- See CustomContentImageScalingConfigurationType
- See VisualInteractionOptionsTypeDef
DashboardPublishOptionsTypeDef#
# DashboardPublishOptionsTypeDef definition
class DashboardPublishOptionsTypeDef(TypedDict):
AdHocFilteringOption: NotRequired[AdHocFilteringOptionTypeDef], # (1)
ExportToCSVOption: NotRequired[ExportToCSVOptionTypeDef], # (2)
SheetControlsOption: NotRequired[SheetControlsOptionTypeDef], # (3)
VisualPublishOptions: NotRequired[DashboardVisualPublishOptionsTypeDef], # (4)
SheetLayoutElementMaximizationOption: NotRequired[SheetLayoutElementMaximizationOptionTypeDef], # (5)
VisualMenuOption: NotRequired[VisualMenuOptionTypeDef], # (6)
VisualAxisSortOption: NotRequired[VisualAxisSortOptionTypeDef], # (7)
ExportWithHiddenFieldsOption: NotRequired[ExportWithHiddenFieldsOptionTypeDef], # (8)
DataPointDrillUpDownOption: NotRequired[DataPointDrillUpDownOptionTypeDef], # (9)
DataPointMenuLabelOption: NotRequired[DataPointMenuLabelOptionTypeDef], # (10)
DataPointTooltipOption: NotRequired[DataPointTooltipOptionTypeDef], # (11)
- See AdHocFilteringOptionTypeDef
- See ExportToCSVOptionTypeDef
- See SheetControlsOptionTypeDef
- See DashboardVisualPublishOptionsTypeDef
- See SheetLayoutElementMaximizationOptionTypeDef
- See VisualMenuOptionTypeDef
- See VisualAxisSortOptionTypeDef
- See ExportWithHiddenFieldsOptionTypeDef
- See DataPointDrillUpDownOptionTypeDef
- See DataPointMenuLabelOptionTypeDef
- See DataPointTooltipOptionTypeDef
DataPathColorTypeDef#
# DataPathColorTypeDef definition
class DataPathColorTypeDef(TypedDict):
Element: DataPathValueTypeDef, # (1)
Color: str,
TimeGranularity: NotRequired[TimeGranularityType], # (2)
DataPathSortTypeDef#
# DataPathSortTypeDef definition
class DataPathSortTypeDef(TypedDict):
Direction: SortDirectionType, # (1)
SortPaths: Sequence[DataPathValueTypeDef], # (2)
PivotTableDataPathOptionTypeDef#
# PivotTableDataPathOptionTypeDef definition
class PivotTableDataPathOptionTypeDef(TypedDict):
DataPathList: Sequence[DataPathValueTypeDef], # (1)
Width: NotRequired[str],
PivotTableFieldCollapseStateTargetTypeDef#
# PivotTableFieldCollapseStateTargetTypeDef definition
class PivotTableFieldCollapseStateTargetTypeDef(TypedDict):
FieldId: NotRequired[str],
FieldDataPathValues: NotRequired[Sequence[DataPathValueTypeDef]], # (1)
TimeRangeFilterTypeDef#
# TimeRangeFilterTypeDef definition
class TimeRangeFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
NullOption: FilterNullOptionType, # (4)
IncludeMinimum: NotRequired[bool],
IncludeMaximum: NotRequired[bool],
RangeMinimumValue: NotRequired[TimeRangeFilterValueTypeDef], # (2)
RangeMaximumValue: NotRequired[TimeRangeFilterValueTypeDef], # (2)
ExcludePeriodConfiguration: NotRequired[ExcludePeriodConfigurationTypeDef], # (5)
TimeGranularity: NotRequired[TimeGranularityType], # (6)
- See ColumnIdentifierTypeDef
- See TimeRangeFilterValueTypeDef
- See TimeRangeFilterValueTypeDef
- See FilterNullOptionType
- See ExcludePeriodConfigurationTypeDef
- See TimeGranularityType
DefaultFormattingTypeDef#
# DefaultFormattingTypeDef definition
class DefaultFormattingTypeDef(TypedDict):
DisplayFormat: NotRequired[DisplayFormatType], # (1)
DisplayFormatOptions: NotRequired[DisplayFormatOptionsTypeDef], # (2)
CustomActionFilterOperationTypeDef#
# CustomActionFilterOperationTypeDef definition
class CustomActionFilterOperationTypeDef(TypedDict):
SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfigurationTypeDef, # (1)
TargetVisualsConfiguration: FilterOperationTargetVisualsConfigurationTypeDef, # (2)
- See FilterOperationSelectedFieldsConfigurationTypeDef
- See FilterOperationTargetVisualsConfigurationTypeDef
AxisLabelOptionsTypeDef#
# AxisLabelOptionsTypeDef definition
class AxisLabelOptionsTypeDef(TypedDict):
FontConfiguration: NotRequired[FontConfigurationTypeDef], # (1)
CustomLabel: NotRequired[str],
ApplyTo: NotRequired[AxisLabelReferenceOptionsTypeDef], # (2)
DataLabelOptionsTypeDef#
# DataLabelOptionsTypeDef definition
class DataLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
CategoryLabelVisibility: NotRequired[VisibilityType], # (1)
MeasureLabelVisibility: NotRequired[VisibilityType], # (1)
DataLabelTypes: NotRequired[Sequence[DataLabelTypeTypeDef]], # (4)
Position: NotRequired[DataLabelPositionType], # (5)
LabelContent: NotRequired[DataLabelContentType], # (6)
LabelFontConfiguration: NotRequired[FontConfigurationTypeDef], # (7)
LabelColor: NotRequired[str],
Overlap: NotRequired[DataLabelOverlapType], # (8)
TotalsVisibility: NotRequired[VisibilityType], # (1)
- See VisibilityType
- See VisibilityType
- See VisibilityType
- See DataLabelTypeTypeDef
- See DataLabelPositionType
- See DataLabelContentType
- See FontConfigurationTypeDef
- See DataLabelOverlapType
- See VisibilityType
FunnelChartDataLabelOptionsTypeDef#
# FunnelChartDataLabelOptionsTypeDef definition
class FunnelChartDataLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
CategoryLabelVisibility: NotRequired[VisibilityType], # (1)
MeasureLabelVisibility: NotRequired[VisibilityType], # (1)
Position: NotRequired[DataLabelPositionType], # (4)
LabelFontConfiguration: NotRequired[FontConfigurationTypeDef], # (5)
LabelColor: NotRequired[str],
MeasureDataLabelStyle: NotRequired[FunnelChartMeasureDataLabelStyleType], # (6)
- See VisibilityType
- See VisibilityType
- See VisibilityType
- See DataLabelPositionType
- See FontConfigurationTypeDef
- See FunnelChartMeasureDataLabelStyleType
LabelOptionsTypeDef#
# LabelOptionsTypeDef definition
class LabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
FontConfiguration: NotRequired[FontConfigurationTypeDef], # (2)
CustomLabel: NotRequired[str],
PanelTitleOptionsTypeDef#
# PanelTitleOptionsTypeDef definition
class PanelTitleOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
FontConfiguration: NotRequired[FontConfigurationTypeDef], # (2)
HorizontalTextAlignment: NotRequired[HorizontalTextAlignmentType], # (3)
TableFieldCustomTextContentTypeDef#
# TableFieldCustomTextContentTypeDef definition
class TableFieldCustomTextContentTypeDef(TypedDict):
FontConfiguration: FontConfigurationTypeDef, # (1)
Value: NotRequired[str],
DefaultFreeFormLayoutConfigurationTypeDef#
# DefaultFreeFormLayoutConfigurationTypeDef definition
class DefaultFreeFormLayoutConfigurationTypeDef(TypedDict):
CanvasSizeOptions: FreeFormLayoutCanvasSizeOptionsTypeDef, # (1)
SnapshotUserConfigurationTypeDef#
# SnapshotUserConfigurationTypeDef definition
class SnapshotUserConfigurationTypeDef(TypedDict):
AnonymousUsers: NotRequired[Sequence[SnapshotAnonymousUserTypeDef]], # (1)
GeospatialHeatmapConfigurationTypeDef#
# GeospatialHeatmapConfigurationTypeDef definition
class GeospatialHeatmapConfigurationTypeDef(TypedDict):
HeatmapColor: NotRequired[GeospatialHeatmapColorScaleTypeDef], # (1)
GlobalTableBorderOptionsTypeDef#
# GlobalTableBorderOptionsTypeDef definition
class GlobalTableBorderOptionsTypeDef(TypedDict):
UniformBorder: NotRequired[TableBorderOptionsTypeDef], # (1)
SideSpecificBorder: NotRequired[TableSideBorderOptionsTypeDef], # (2)
ConditionalFormattingGradientColorTypeDef#
# ConditionalFormattingGradientColorTypeDef definition
class ConditionalFormattingGradientColorTypeDef(TypedDict):
Expression: str,
Color: GradientColorTypeDef, # (1)
DefaultGridLayoutConfigurationTypeDef#
# DefaultGridLayoutConfigurationTypeDef definition
class DefaultGridLayoutConfigurationTypeDef(TypedDict):
CanvasSizeOptions: GridLayoutCanvasSizeOptionsTypeDef, # (1)
GridLayoutConfigurationTypeDef#
# GridLayoutConfigurationTypeDef definition
class GridLayoutConfigurationTypeDef(TypedDict):
Elements: Sequence[GridLayoutElementTypeDef], # (1)
CanvasSizeOptions: NotRequired[GridLayoutCanvasSizeOptionsTypeDef], # (2)
RefreshConfigurationTypeDef#
# RefreshConfigurationTypeDef definition
class RefreshConfigurationTypeDef(TypedDict):
IncrementalRefresh: IncrementalRefreshTypeDef, # (1)
DescribeIngestionResponseTypeDef#
# DescribeIngestionResponseTypeDef definition
class DescribeIngestionResponseTypeDef(TypedDict):
Ingestion: IngestionTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListIngestionsResponseTypeDef#
# ListIngestionsResponseTypeDef definition
class ListIngestionsResponseTypeDef(TypedDict):
Ingestions: List[IngestionTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LogicalTableSourceTypeDef#
# LogicalTableSourceTypeDef definition
class LogicalTableSourceTypeDef(TypedDict):
JoinInstruction: NotRequired[JoinInstructionTypeDef], # (1)
PhysicalTableId: NotRequired[str],
DataSetArn: NotRequired[str],
DataFieldSeriesItemTypeDef#
# DataFieldSeriesItemTypeDef definition
class DataFieldSeriesItemTypeDef(TypedDict):
FieldId: str,
AxisBinding: AxisBindingType, # (1)
FieldValue: NotRequired[str],
Settings: NotRequired[LineChartSeriesSettingsTypeDef], # (2)
FieldSeriesItemTypeDef#
# FieldSeriesItemTypeDef definition
class FieldSeriesItemTypeDef(TypedDict):
FieldId: str,
AxisBinding: AxisBindingType, # (1)
Settings: NotRequired[LineChartSeriesSettingsTypeDef], # (2)
SheetStyleTypeDef#
# SheetStyleTypeDef definition
class SheetStyleTypeDef(TypedDict):
Tile: NotRequired[TileStyleTypeDef], # (1)
TileLayout: NotRequired[TileLayoutStyleTypeDef], # (2)
TopicNamedEntityTypeDef#
# TopicNamedEntityTypeDef definition
class TopicNamedEntityTypeDef(TypedDict):
EntityName: str,
EntityDescription: NotRequired[str],
EntitySynonyms: NotRequired[Sequence[str]],
SemanticEntityType: NotRequired[SemanticEntityTypeTypeDef], # (1)
Definition: NotRequired[Sequence[NamedEntityDefinitionTypeDef]], # (2)
DescribeNamespaceResponseTypeDef#
# DescribeNamespaceResponseTypeDef definition
class DescribeNamespaceResponseTypeDef(TypedDict):
Namespace: NamespaceInfoV2TypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNamespacesResponseTypeDef#
# ListNamespacesResponseTypeDef definition
class ListNamespacesResponseTypeDef(TypedDict):
Namespaces: List[NamespaceInfoV2TypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListVPCConnectionsResponseTypeDef#
# ListVPCConnectionsResponseTypeDef definition
class ListVPCConnectionsResponseTypeDef(TypedDict):
VPCConnectionSummaries: List[VPCConnectionSummaryTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeVPCConnectionResponseTypeDef#
# DescribeVPCConnectionResponseTypeDef definition
class DescribeVPCConnectionResponseTypeDef(TypedDict):
VPCConnection: VPCConnectionTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CurrencyDisplayFormatConfigurationTypeDef#
# CurrencyDisplayFormatConfigurationTypeDef definition
class CurrencyDisplayFormatConfigurationTypeDef(TypedDict):
Prefix: NotRequired[str],
Suffix: NotRequired[str],
SeparatorConfiguration: NotRequired[NumericSeparatorConfigurationTypeDef], # (1)
Symbol: NotRequired[str],
DecimalPlacesConfiguration: NotRequired[DecimalPlacesConfigurationTypeDef], # (2)
NumberScale: NotRequired[NumberScaleType], # (3)
NegativeValueConfiguration: NotRequired[NegativeValueConfigurationTypeDef], # (4)
NullValueFormatConfiguration: NotRequired[NullValueFormatConfigurationTypeDef], # (5)
- See NumericSeparatorConfigurationTypeDef
- See DecimalPlacesConfigurationTypeDef
- See NumberScaleType
- See NegativeValueConfigurationTypeDef
- See NullValueFormatConfigurationTypeDef
NumberDisplayFormatConfigurationTypeDef#
# NumberDisplayFormatConfigurationTypeDef definition
class NumberDisplayFormatConfigurationTypeDef(TypedDict):
Prefix: NotRequired[str],
Suffix: NotRequired[str],
SeparatorConfiguration: NotRequired[NumericSeparatorConfigurationTypeDef], # (1)
DecimalPlacesConfiguration: NotRequired[DecimalPlacesConfigurationTypeDef], # (2)
NumberScale: NotRequired[NumberScaleType], # (3)
NegativeValueConfiguration: NotRequired[NegativeValueConfigurationTypeDef], # (4)
NullValueFormatConfiguration: NotRequired[NullValueFormatConfigurationTypeDef], # (5)
- See NumericSeparatorConfigurationTypeDef
- See DecimalPlacesConfigurationTypeDef
- See NumberScaleType
- See NegativeValueConfigurationTypeDef
- See NullValueFormatConfigurationTypeDef
PercentageDisplayFormatConfigurationTypeDef#
# PercentageDisplayFormatConfigurationTypeDef definition
class PercentageDisplayFormatConfigurationTypeDef(TypedDict):
Prefix: NotRequired[str],
Suffix: NotRequired[str],
SeparatorConfiguration: NotRequired[NumericSeparatorConfigurationTypeDef], # (1)
DecimalPlacesConfiguration: NotRequired[DecimalPlacesConfigurationTypeDef], # (2)
NegativeValueConfiguration: NotRequired[NegativeValueConfigurationTypeDef], # (3)
NullValueFormatConfiguration: NotRequired[NullValueFormatConfigurationTypeDef], # (4)
- See NumericSeparatorConfigurationTypeDef
- See DecimalPlacesConfigurationTypeDef
- See NegativeValueConfigurationTypeDef
- See NullValueFormatConfigurationTypeDef
AggregationFunctionTypeDef#
# AggregationFunctionTypeDef definition
class AggregationFunctionTypeDef(TypedDict):
NumericalAggregationFunction: NotRequired[NumericalAggregationFunctionTypeDef], # (1)
CategoricalAggregationFunction: NotRequired[CategoricalAggregationFunctionType], # (2)
DateAggregationFunction: NotRequired[DateAggregationFunctionType], # (3)
AttributeAggregationFunction: NotRequired[AttributeAggregationFunctionTypeDef], # (4)
- See NumericalAggregationFunctionTypeDef
- See CategoricalAggregationFunctionType
- See DateAggregationFunctionType
- See AttributeAggregationFunctionTypeDef
ScrollBarOptionsTypeDef#
# ScrollBarOptionsTypeDef definition
class ScrollBarOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
VisibleRange: NotRequired[VisibleRangeOptionsTypeDef], # (2)
TopicDateRangeFilterTypeDef#
# TopicDateRangeFilterTypeDef definition
class TopicDateRangeFilterTypeDef(TypedDict):
Inclusive: NotRequired[bool],
Constant: NotRequired[TopicRangeFilterConstantTypeDef], # (1)
TopicNumericRangeFilterTypeDef#
# TopicNumericRangeFilterTypeDef definition
class TopicNumericRangeFilterTypeDef(TypedDict):
Inclusive: NotRequired[bool],
Constant: NotRequired[TopicRangeFilterConstantTypeDef], # (1)
Aggregation: NotRequired[NamedFilterAggTypeType], # (2)
DataSourceParametersPaginatorTypeDef#
# DataSourceParametersPaginatorTypeDef definition
class DataSourceParametersPaginatorTypeDef(TypedDict):
AmazonElasticsearchParameters: NotRequired[AmazonElasticsearchParametersTypeDef], # (1)
AthenaParameters: NotRequired[AthenaParametersTypeDef], # (2)
AuroraParameters: NotRequired[AuroraParametersTypeDef], # (3)
AuroraPostgreSqlParameters: NotRequired[AuroraPostgreSqlParametersTypeDef], # (4)
AwsIotAnalyticsParameters: NotRequired[AwsIotAnalyticsParametersTypeDef], # (5)
JiraParameters: NotRequired[JiraParametersTypeDef], # (6)
MariaDbParameters: NotRequired[MariaDbParametersTypeDef], # (7)
MySqlParameters: NotRequired[MySqlParametersTypeDef], # (8)
OracleParameters: NotRequired[OracleParametersTypeDef], # (9)
PostgreSqlParameters: NotRequired[PostgreSqlParametersTypeDef], # (10)
PrestoParameters: NotRequired[PrestoParametersTypeDef], # (11)
RdsParameters: NotRequired[RdsParametersTypeDef], # (12)
RedshiftParameters: NotRequired[RedshiftParametersPaginatorTypeDef], # (13)
S3Parameters: NotRequired[S3ParametersTypeDef], # (14)
ServiceNowParameters: NotRequired[ServiceNowParametersTypeDef], # (15)
SnowflakeParameters: NotRequired[SnowflakeParametersTypeDef], # (16)
SparkParameters: NotRequired[SparkParametersTypeDef], # (17)
SqlServerParameters: NotRequired[SqlServerParametersTypeDef], # (18)
TeradataParameters: NotRequired[TeradataParametersTypeDef], # (19)
TwitterParameters: NotRequired[TwitterParametersTypeDef], # (20)
AmazonOpenSearchParameters: NotRequired[AmazonOpenSearchParametersTypeDef], # (21)
ExasolParameters: NotRequired[ExasolParametersTypeDef], # (22)
DatabricksParameters: NotRequired[DatabricksParametersTypeDef], # (23)
StarburstParameters: NotRequired[StarburstParametersTypeDef], # (24)
TrinoParameters: NotRequired[TrinoParametersTypeDef], # (25)
BigQueryParameters: NotRequired[BigQueryParametersTypeDef], # (26)
- See AmazonElasticsearchParametersTypeDef
- See AthenaParametersTypeDef
- See AuroraParametersTypeDef
- See AuroraPostgreSqlParametersTypeDef
- See AwsIotAnalyticsParametersTypeDef
- See JiraParametersTypeDef
- See MariaDbParametersTypeDef
- See MySqlParametersTypeDef
- See OracleParametersTypeDef
- See PostgreSqlParametersTypeDef
- See PrestoParametersTypeDef
- See RdsParametersTypeDef
- See RedshiftParametersPaginatorTypeDef
- See S3ParametersTypeDef
- See ServiceNowParametersTypeDef
- See SnowflakeParametersTypeDef
- See SparkParametersTypeDef
- See SqlServerParametersTypeDef
- See TeradataParametersTypeDef
- See TwitterParametersTypeDef
- See AmazonOpenSearchParametersTypeDef
- See ExasolParametersTypeDef
- See DatabricksParametersTypeDef
- See StarburstParametersTypeDef
- See TrinoParametersTypeDef
- See BigQueryParametersTypeDef
DataSourceParametersTypeDef#
# DataSourceParametersTypeDef definition
class DataSourceParametersTypeDef(TypedDict):
AmazonElasticsearchParameters: NotRequired[AmazonElasticsearchParametersTypeDef], # (1)
AthenaParameters: NotRequired[AthenaParametersTypeDef], # (2)
AuroraParameters: NotRequired[AuroraParametersTypeDef], # (3)
AuroraPostgreSqlParameters: NotRequired[AuroraPostgreSqlParametersTypeDef], # (4)
AwsIotAnalyticsParameters: NotRequired[AwsIotAnalyticsParametersTypeDef], # (5)
JiraParameters: NotRequired[JiraParametersTypeDef], # (6)
MariaDbParameters: NotRequired[MariaDbParametersTypeDef], # (7)
MySqlParameters: NotRequired[MySqlParametersTypeDef], # (8)
OracleParameters: NotRequired[OracleParametersTypeDef], # (9)
PostgreSqlParameters: NotRequired[PostgreSqlParametersTypeDef], # (10)
PrestoParameters: NotRequired[PrestoParametersTypeDef], # (11)
RdsParameters: NotRequired[RdsParametersTypeDef], # (12)
RedshiftParameters: NotRequired[RedshiftParametersTypeDef], # (13)
S3Parameters: NotRequired[S3ParametersTypeDef], # (14)
ServiceNowParameters: NotRequired[ServiceNowParametersTypeDef], # (15)
SnowflakeParameters: NotRequired[SnowflakeParametersTypeDef], # (16)
SparkParameters: NotRequired[SparkParametersTypeDef], # (17)
SqlServerParameters: NotRequired[SqlServerParametersTypeDef], # (18)
TeradataParameters: NotRequired[TeradataParametersTypeDef], # (19)
TwitterParameters: NotRequired[TwitterParametersTypeDef], # (20)
AmazonOpenSearchParameters: NotRequired[AmazonOpenSearchParametersTypeDef], # (21)
ExasolParameters: NotRequired[ExasolParametersTypeDef], # (22)
DatabricksParameters: NotRequired[DatabricksParametersTypeDef], # (23)
StarburstParameters: NotRequired[StarburstParametersTypeDef], # (24)
TrinoParameters: NotRequired[TrinoParametersTypeDef], # (25)
BigQueryParameters: NotRequired[BigQueryParametersTypeDef], # (26)
- See AmazonElasticsearchParametersTypeDef
- See AthenaParametersTypeDef
- See AuroraParametersTypeDef
- See AuroraPostgreSqlParametersTypeDef
- See AwsIotAnalyticsParametersTypeDef
- See JiraParametersTypeDef
- See MariaDbParametersTypeDef
- See MySqlParametersTypeDef
- See OracleParametersTypeDef
- See PostgreSqlParametersTypeDef
- See PrestoParametersTypeDef
- See RdsParametersTypeDef
- See RedshiftParametersTypeDef
- See S3ParametersTypeDef
- See ServiceNowParametersTypeDef
- See SnowflakeParametersTypeDef
- See SparkParametersTypeDef
- See SqlServerParametersTypeDef
- See TeradataParametersTypeDef
- See TwitterParametersTypeDef
- See AmazonOpenSearchParametersTypeDef
- See ExasolParametersTypeDef
- See DatabricksParametersTypeDef
- See StarburstParametersTypeDef
- See TrinoParametersTypeDef
- See BigQueryParametersTypeDef
RefreshScheduleTypeDef#
# RefreshScheduleTypeDef definition
class RefreshScheduleTypeDef(TypedDict):
ScheduleId: str,
ScheduleFrequency: RefreshFrequencyTypeDef, # (1)
RefreshType: IngestionTypeType, # (2)
StartAfterDateTime: NotRequired[Union[datetime, str]],
Arn: NotRequired[str],
RegisteredUserQuickSightConsoleEmbeddingConfigurationTypeDef#
# RegisteredUserQuickSightConsoleEmbeddingConfigurationTypeDef definition
class RegisteredUserQuickSightConsoleEmbeddingConfigurationTypeDef(TypedDict):
InitialPath: NotRequired[str],
FeatureConfigurations: NotRequired[RegisteredUserConsoleFeatureConfigurationsTypeDef], # (1)
RegisteredUserDashboardEmbeddingConfigurationTypeDef#
# RegisteredUserDashboardEmbeddingConfigurationTypeDef definition
class RegisteredUserDashboardEmbeddingConfigurationTypeDef(TypedDict):
InitialDashboardId: str,
FeatureConfigurations: NotRequired[RegisteredUserDashboardFeatureConfigurationsTypeDef], # (1)
SnapshotDestinationConfigurationTypeDef#
# SnapshotDestinationConfigurationTypeDef definition
class SnapshotDestinationConfigurationTypeDef(TypedDict):
S3Destinations: NotRequired[List[SnapshotS3DestinationConfigurationTypeDef]], # (1)
SnapshotJobS3ResultTypeDef#
# SnapshotJobS3ResultTypeDef definition
class SnapshotJobS3ResultTypeDef(TypedDict):
S3DestinationConfiguration: NotRequired[SnapshotS3DestinationConfigurationTypeDef], # (1)
S3Uri: NotRequired[str],
ErrorInfo: NotRequired[List[SnapshotJobResultErrorInfoTypeDef]], # (2)
PhysicalTableTypeDef#
# PhysicalTableTypeDef definition
class PhysicalTableTypeDef(TypedDict):
RelationalTable: NotRequired[RelationalTableTypeDef], # (1)
CustomSql: NotRequired[CustomSqlTypeDef], # (2)
S3Source: NotRequired[S3SourceTypeDef], # (3)
- See RelationalTableTypeDef
- See CustomSqlTypeDef
- See S3SourceTypeDef
SectionBasedLayoutCanvasSizeOptionsTypeDef#
# SectionBasedLayoutCanvasSizeOptionsTypeDef definition
class SectionBasedLayoutCanvasSizeOptionsTypeDef(TypedDict):
PaperCanvasSizeOptions: NotRequired[SectionBasedLayoutPaperCanvasSizeOptionsTypeDef], # (1)
FilterScopeConfigurationTypeDef#
# FilterScopeConfigurationTypeDef definition
class FilterScopeConfigurationTypeDef(TypedDict):
SelectedSheets: NotRequired[SelectedSheetsFilterScopeConfigurationTypeDef], # (1)
AllSheets: NotRequired[Mapping[str, Any]],
FreeFormLayoutElementTypeDef#
# FreeFormLayoutElementTypeDef definition
class FreeFormLayoutElementTypeDef(TypedDict):
ElementId: str,
ElementType: LayoutElementTypeType, # (1)
XAxisLocation: str,
YAxisLocation: str,
Width: str,
Height: str,
Visibility: NotRequired[VisibilityType], # (2)
RenderingRules: NotRequired[Sequence[SheetElementRenderingRuleTypeDef]], # (3)
BorderStyle: NotRequired[FreeFormLayoutElementBorderStyleTypeDef], # (4)
SelectedBorderStyle: NotRequired[FreeFormLayoutElementBorderStyleTypeDef], # (4)
BackgroundStyle: NotRequired[FreeFormLayoutElementBackgroundStyleTypeDef], # (6)
LoadingAnimation: NotRequired[LoadingAnimationTypeDef], # (7)
- See LayoutElementTypeType
- See VisibilityType
- See SheetElementRenderingRuleTypeDef
- See FreeFormLayoutElementBorderStyleTypeDef
- See FreeFormLayoutElementBorderStyleTypeDef
- See FreeFormLayoutElementBackgroundStyleTypeDef
- See LoadingAnimationTypeDef
SnapshotFileGroupTypeDef#
# SnapshotFileGroupTypeDef definition
class SnapshotFileGroupTypeDef(TypedDict):
Files: NotRequired[List[SnapshotFileTypeDef]], # (1)
DateTimeParameterDeclarationTypeDef#
# DateTimeParameterDeclarationTypeDef definition
class DateTimeParameterDeclarationTypeDef(TypedDict):
Name: str,
DefaultValues: NotRequired[DateTimeDefaultValuesTypeDef], # (1)
TimeGranularity: NotRequired[TimeGranularityType], # (2)
ValueWhenUnset: NotRequired[DateTimeValueWhenUnsetConfigurationTypeDef], # (3)
MappedDataSetParameters: NotRequired[Sequence[MappedDataSetParameterTypeDef]], # (4)
- See DateTimeDefaultValuesTypeDef
- See TimeGranularityType
- See DateTimeValueWhenUnsetConfigurationTypeDef
- See MappedDataSetParameterTypeDef
DecimalParameterDeclarationTypeDef#
# DecimalParameterDeclarationTypeDef definition
class DecimalParameterDeclarationTypeDef(TypedDict):
ParameterValueType: ParameterValueTypeType, # (1)
Name: str,
DefaultValues: NotRequired[DecimalDefaultValuesTypeDef], # (2)
ValueWhenUnset: NotRequired[DecimalValueWhenUnsetConfigurationTypeDef], # (3)
MappedDataSetParameters: NotRequired[Sequence[MappedDataSetParameterTypeDef]], # (4)
- See ParameterValueTypeType
- See DecimalDefaultValuesTypeDef
- See DecimalValueWhenUnsetConfigurationTypeDef
- See MappedDataSetParameterTypeDef
IntegerParameterDeclarationTypeDef#
# IntegerParameterDeclarationTypeDef definition
class IntegerParameterDeclarationTypeDef(TypedDict):
ParameterValueType: ParameterValueTypeType, # (1)
Name: str,
DefaultValues: NotRequired[IntegerDefaultValuesTypeDef], # (2)
ValueWhenUnset: NotRequired[IntegerValueWhenUnsetConfigurationTypeDef], # (3)
MappedDataSetParameters: NotRequired[Sequence[MappedDataSetParameterTypeDef]], # (4)
- See ParameterValueTypeType
- See IntegerDefaultValuesTypeDef
- See IntegerValueWhenUnsetConfigurationTypeDef
- See MappedDataSetParameterTypeDef
StringParameterDeclarationTypeDef#
# StringParameterDeclarationTypeDef definition
class StringParameterDeclarationTypeDef(TypedDict):
ParameterValueType: ParameterValueTypeType, # (1)
Name: str,
DefaultValues: NotRequired[StringDefaultValuesTypeDef], # (2)
ValueWhenUnset: NotRequired[StringValueWhenUnsetConfigurationTypeDef], # (3)
MappedDataSetParameters: NotRequired[Sequence[MappedDataSetParameterTypeDef]], # (4)
- See ParameterValueTypeType
- See StringDefaultValuesTypeDef
- See StringValueWhenUnsetConfigurationTypeDef
- See MappedDataSetParameterTypeDef
DescribeAnalysisResponseTypeDef#
# DescribeAnalysisResponseTypeDef definition
class DescribeAnalysisResponseTypeDef(TypedDict):
Analysis: AnalysisTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DashboardTypeDef#
# DashboardTypeDef definition
class DashboardTypeDef(TypedDict):
DashboardId: NotRequired[str],
Arn: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[DashboardVersionTypeDef], # (1)
CreatedTime: NotRequired[datetime],
LastPublishedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
LinkEntities: NotRequired[List[str]],
GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef#
# GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef definition
class GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
Namespace: str,
AuthorizedResourceArns: Sequence[str],
ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfigurationTypeDef, # (1)
SessionLifetimeInMinutes: NotRequired[int],
SessionTags: NotRequired[Sequence[SessionTagTypeDef]], # (2)
AllowedDomains: NotRequired[Sequence[str]],
AssetBundleImportJobOverridePermissionsTypeDef#
# AssetBundleImportJobOverridePermissionsTypeDef definition
class AssetBundleImportJobOverridePermissionsTypeDef(TypedDict):
DataSources: NotRequired[List[AssetBundleImportJobDataSourceOverridePermissionsTypeDef]], # (1)
DataSets: NotRequired[List[AssetBundleImportJobDataSetOverridePermissionsTypeDef]], # (2)
Themes: NotRequired[List[AssetBundleImportJobThemeOverridePermissionsTypeDef]], # (3)
Analyses: NotRequired[List[AssetBundleImportJobAnalysisOverridePermissionsTypeDef]], # (4)
Dashboards: NotRequired[List[AssetBundleImportJobDashboardOverridePermissionsTypeDef]], # (5)
- See AssetBundleImportJobDataSourceOverridePermissionsTypeDef
- See AssetBundleImportJobDataSetOverridePermissionsTypeDef
- See AssetBundleImportJobThemeOverridePermissionsTypeDef
- See AssetBundleImportJobAnalysisOverridePermissionsTypeDef
- See AssetBundleImportJobDashboardOverridePermissionsTypeDef
AxisDataOptionsTypeDef#
# AxisDataOptionsTypeDef definition
class AxisDataOptionsTypeDef(TypedDict):
NumericAxisOptions: NotRequired[NumericAxisOptionsTypeDef], # (1)
DateAxisOptions: NotRequired[DateAxisOptionsTypeDef], # (2)
TemplateVersionTypeDef#
# TemplateVersionTypeDef definition
class TemplateVersionTypeDef(TypedDict):
CreatedTime: NotRequired[datetime],
Errors: NotRequired[List[TemplateErrorTypeDef]], # (1)
VersionNumber: NotRequired[int],
Status: NotRequired[ResourceStatusType], # (2)
DataSetConfigurations: NotRequired[List[DataSetConfigurationTypeDef]], # (3)
Description: NotRequired[str],
SourceEntityArn: NotRequired[str],
ThemeArn: NotRequired[str],
Sheets: NotRequired[List[SheetTypeDef]], # (4)
DestinationParameterValueConfigurationTypeDef#
# DestinationParameterValueConfigurationTypeDef definition
class DestinationParameterValueConfigurationTypeDef(TypedDict):
CustomValuesConfiguration: NotRequired[CustomValuesConfigurationTypeDef], # (1)
SelectAllValueOptions: NotRequired[SelectAllValueOptionsType], # (2)
SourceParameterName: NotRequired[str],
SourceField: NotRequired[str],
SourceColumn: NotRequired[ColumnIdentifierTypeDef], # (3)
DatasetParameterTypeDef#
# DatasetParameterTypeDef definition
class DatasetParameterTypeDef(TypedDict):
StringDatasetParameter: NotRequired[StringDatasetParameterTypeDef], # (1)
DecimalDatasetParameter: NotRequired[DecimalDatasetParameterTypeDef], # (2)
IntegerDatasetParameter: NotRequired[IntegerDatasetParameterTypeDef], # (3)
DateTimeDatasetParameter: NotRequired[DateTimeDatasetParameterTypeDef], # (4)
- See StringDatasetParameterTypeDef
- See DecimalDatasetParameterTypeDef
- See IntegerDatasetParameterTypeDef
- See DateTimeDatasetParameterTypeDef
TransformOperationTypeDef#
# TransformOperationTypeDef definition
class TransformOperationTypeDef(TypedDict):
ProjectOperation: NotRequired[ProjectOperationTypeDef], # (1)
FilterOperation: NotRequired[FilterOperationTypeDef], # (2)
CreateColumnsOperation: NotRequired[CreateColumnsOperationTypeDef], # (3)
RenameColumnOperation: NotRequired[RenameColumnOperationTypeDef], # (4)
CastColumnTypeOperation: NotRequired[CastColumnTypeOperationTypeDef], # (5)
TagColumnOperation: NotRequired[TagColumnOperationTypeDef], # (6)
UntagColumnOperation: NotRequired[UntagColumnOperationTypeDef], # (7)
OverrideDatasetParameterOperation: NotRequired[OverrideDatasetParameterOperationTypeDef], # (8)
- See ProjectOperationTypeDef
- See FilterOperationTypeDef
- See CreateColumnsOperationTypeDef
- See RenameColumnOperationTypeDef
- See CastColumnTypeOperationTypeDef
- See TagColumnOperationTypeDef
- See UntagColumnOperationTypeDef
- See OverrideDatasetParameterOperationTypeDef
DateTimeHierarchyTypeDef#
# DateTimeHierarchyTypeDef definition
class DateTimeHierarchyTypeDef(TypedDict):
HierarchyId: str,
DrillDownFilters: NotRequired[Sequence[DrillDownFilterTypeDef]], # (1)
ExplicitHierarchyTypeDef#
# ExplicitHierarchyTypeDef definition
class ExplicitHierarchyTypeDef(TypedDict):
HierarchyId: str,
Columns: Sequence[ColumnIdentifierTypeDef], # (1)
DrillDownFilters: NotRequired[Sequence[DrillDownFilterTypeDef]], # (2)
PredefinedHierarchyTypeDef#
# PredefinedHierarchyTypeDef definition
class PredefinedHierarchyTypeDef(TypedDict):
HierarchyId: str,
Columns: Sequence[ColumnIdentifierTypeDef], # (1)
DrillDownFilters: NotRequired[Sequence[DrillDownFilterTypeDef]], # (2)
ListTopicRefreshSchedulesResponseTypeDef#
# ListTopicRefreshSchedulesResponseTypeDef definition
class ListTopicRefreshSchedulesResponseTypeDef(TypedDict):
TopicId: str,
TopicArn: str,
RefreshSchedules: List[TopicRefreshScheduleSummaryTypeDef], # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ForecastConfigurationTypeDef#
# ForecastConfigurationTypeDef definition
class ForecastConfigurationTypeDef(TypedDict):
ForecastProperties: NotRequired[TimeBasedForecastPropertiesTypeDef], # (1)
Scenario: NotRequired[ForecastScenarioTypeDef], # (2)
VisualPaletteTypeDef#
# VisualPaletteTypeDef definition
class VisualPaletteTypeDef(TypedDict):
ChartColor: NotRequired[str],
ColorMap: NotRequired[Sequence[DataPathColorTypeDef]], # (1)
PivotTableFieldCollapseStateOptionTypeDef#
# PivotTableFieldCollapseStateOptionTypeDef definition
class PivotTableFieldCollapseStateOptionTypeDef(TypedDict):
Target: PivotTableFieldCollapseStateTargetTypeDef, # (1)
State: NotRequired[PivotTableFieldCollapseStateType], # (2)
TopicCalculatedFieldTypeDef#
# TopicCalculatedFieldTypeDef definition
class TopicCalculatedFieldTypeDef(TypedDict):
CalculatedFieldName: str,
Expression: str,
CalculatedFieldDescription: NotRequired[str],
CalculatedFieldSynonyms: NotRequired[Sequence[str]],
IsIncludedInTopic: NotRequired[bool],
DisableIndexing: NotRequired[bool],
ColumnDataRole: NotRequired[ColumnDataRoleType], # (1)
TimeGranularity: NotRequired[TopicTimeGranularityType], # (2)
DefaultFormatting: NotRequired[DefaultFormattingTypeDef], # (3)
Aggregation: NotRequired[DefaultAggregationType], # (4)
ComparativeOrder: NotRequired[ComparativeOrderTypeDef], # (5)
SemanticType: NotRequired[SemanticTypeTypeDef], # (6)
AllowedAggregations: NotRequired[Sequence[AuthorSpecifiedAggregationType]], # (7)
NotAllowedAggregations: NotRequired[Sequence[AuthorSpecifiedAggregationType]], # (7)
NeverAggregateInFilter: NotRequired[bool],
CellValueSynonyms: NotRequired[Sequence[CellValueSynonymTypeDef]], # (9)
NonAdditive: NotRequired[bool],
- See ColumnDataRoleType
- See TopicTimeGranularityType
- See DefaultFormattingTypeDef
- See DefaultAggregationType
- See ComparativeOrderTypeDef
- See SemanticTypeTypeDef
- See AuthorSpecifiedAggregationType
- See AuthorSpecifiedAggregationType
- See CellValueSynonymTypeDef
TopicColumnTypeDef#
# TopicColumnTypeDef definition
class TopicColumnTypeDef(TypedDict):
ColumnName: str,
ColumnFriendlyName: NotRequired[str],
ColumnDescription: NotRequired[str],
ColumnSynonyms: NotRequired[Sequence[str]],
ColumnDataRole: NotRequired[ColumnDataRoleType], # (1)
Aggregation: NotRequired[DefaultAggregationType], # (2)
IsIncludedInTopic: NotRequired[bool],
DisableIndexing: NotRequired[bool],
ComparativeOrder: NotRequired[ComparativeOrderTypeDef], # (3)
SemanticType: NotRequired[SemanticTypeTypeDef], # (4)
TimeGranularity: NotRequired[TopicTimeGranularityType], # (5)
AllowedAggregations: NotRequired[Sequence[AuthorSpecifiedAggregationType]], # (6)
NotAllowedAggregations: NotRequired[Sequence[AuthorSpecifiedAggregationType]], # (6)
DefaultFormatting: NotRequired[DefaultFormattingTypeDef], # (8)
NeverAggregateInFilter: NotRequired[bool],
CellValueSynonyms: NotRequired[Sequence[CellValueSynonymTypeDef]], # (9)
NonAdditive: NotRequired[bool],
- See ColumnDataRoleType
- See DefaultAggregationType
- See ComparativeOrderTypeDef
- See SemanticTypeTypeDef
- See TopicTimeGranularityType
- See AuthorSpecifiedAggregationType
- See AuthorSpecifiedAggregationType
- See DefaultFormattingTypeDef
- See CellValueSynonymTypeDef
ChartAxisLabelOptionsTypeDef#
# ChartAxisLabelOptionsTypeDef definition
class ChartAxisLabelOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
SortIconVisibility: NotRequired[VisibilityType], # (1)
AxisLabelOptions: NotRequired[Sequence[AxisLabelOptionsTypeDef]], # (3)
- See VisibilityType
- See VisibilityType
- See AxisLabelOptionsTypeDef
AxisTickLabelOptionsTypeDef#
# AxisTickLabelOptionsTypeDef definition
class AxisTickLabelOptionsTypeDef(TypedDict):
LabelOptions: NotRequired[LabelOptionsTypeDef], # (1)
RotationAngle: NotRequired[float],
DateTimePickerControlDisplayOptionsTypeDef#
# DateTimePickerControlDisplayOptionsTypeDef definition
class DateTimePickerControlDisplayOptionsTypeDef(TypedDict):
TitleOptions: NotRequired[LabelOptionsTypeDef], # (1)
DateTimeFormat: NotRequired[str],
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (2)
DropDownControlDisplayOptionsTypeDef#
# DropDownControlDisplayOptionsTypeDef definition
class DropDownControlDisplayOptionsTypeDef(TypedDict):
SelectAllOptions: NotRequired[ListControlSelectAllOptionsTypeDef], # (1)
TitleOptions: NotRequired[LabelOptionsTypeDef], # (2)
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (3)
- See ListControlSelectAllOptionsTypeDef
- See LabelOptionsTypeDef
- See SheetControlInfoIconLabelOptionsTypeDef
LegendOptionsTypeDef#
# LegendOptionsTypeDef definition
class LegendOptionsTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
Title: NotRequired[LabelOptionsTypeDef], # (2)
Position: NotRequired[LegendPositionType], # (3)
Width: NotRequired[str],
Height: NotRequired[str],
- See VisibilityType
- See LabelOptionsTypeDef
- See LegendPositionType
ListControlDisplayOptionsTypeDef#
# ListControlDisplayOptionsTypeDef definition
class ListControlDisplayOptionsTypeDef(TypedDict):
SearchOptions: NotRequired[ListControlSearchOptionsTypeDef], # (1)
SelectAllOptions: NotRequired[ListControlSelectAllOptionsTypeDef], # (2)
TitleOptions: NotRequired[LabelOptionsTypeDef], # (3)
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (4)
- See ListControlSearchOptionsTypeDef
- See ListControlSelectAllOptionsTypeDef
- See LabelOptionsTypeDef
- See SheetControlInfoIconLabelOptionsTypeDef
RelativeDateTimeControlDisplayOptionsTypeDef#
# RelativeDateTimeControlDisplayOptionsTypeDef definition
class RelativeDateTimeControlDisplayOptionsTypeDef(TypedDict):
TitleOptions: NotRequired[LabelOptionsTypeDef], # (1)
DateTimeFormat: NotRequired[str],
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (2)
SliderControlDisplayOptionsTypeDef#
# SliderControlDisplayOptionsTypeDef definition
class SliderControlDisplayOptionsTypeDef(TypedDict):
TitleOptions: NotRequired[LabelOptionsTypeDef], # (1)
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (2)
TextAreaControlDisplayOptionsTypeDef#
# TextAreaControlDisplayOptionsTypeDef definition
class TextAreaControlDisplayOptionsTypeDef(TypedDict):
TitleOptions: NotRequired[LabelOptionsTypeDef], # (1)
PlaceholderOptions: NotRequired[TextControlPlaceholderOptionsTypeDef], # (2)
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (3)
- See LabelOptionsTypeDef
- See TextControlPlaceholderOptionsTypeDef
- See SheetControlInfoIconLabelOptionsTypeDef
TextFieldControlDisplayOptionsTypeDef#
# TextFieldControlDisplayOptionsTypeDef definition
class TextFieldControlDisplayOptionsTypeDef(TypedDict):
TitleOptions: NotRequired[LabelOptionsTypeDef], # (1)
PlaceholderOptions: NotRequired[TextControlPlaceholderOptionsTypeDef], # (2)
InfoIconLabelOptions: NotRequired[SheetControlInfoIconLabelOptionsTypeDef], # (3)
- See LabelOptionsTypeDef
- See TextControlPlaceholderOptionsTypeDef
- See SheetControlInfoIconLabelOptionsTypeDef
PanelConfigurationTypeDef#
# PanelConfigurationTypeDef definition
class PanelConfigurationTypeDef(TypedDict):
Title: NotRequired[PanelTitleOptionsTypeDef], # (1)
BorderVisibility: NotRequired[VisibilityType], # (2)
BorderThickness: NotRequired[str],
BorderStyle: NotRequired[PanelBorderStyleType], # (3)
BorderColor: NotRequired[str],
GutterVisibility: NotRequired[VisibilityType], # (2)
GutterSpacing: NotRequired[str],
BackgroundVisibility: NotRequired[VisibilityType], # (2)
BackgroundColor: NotRequired[str],
- See PanelTitleOptionsTypeDef
- See VisibilityType
- See PanelBorderStyleType
- See VisibilityType
- See VisibilityType
TableFieldLinkContentConfigurationTypeDef#
# TableFieldLinkContentConfigurationTypeDef definition
class TableFieldLinkContentConfigurationTypeDef(TypedDict):
CustomTextContent: NotRequired[TableFieldCustomTextContentTypeDef], # (1)
CustomIconContent: NotRequired[TableFieldCustomIconContentTypeDef], # (2)
GeospatialPointStyleOptionsTypeDef#
# GeospatialPointStyleOptionsTypeDef definition
class GeospatialPointStyleOptionsTypeDef(TypedDict):
SelectedPointStyle: NotRequired[GeospatialSelectedPointStyleType], # (1)
ClusterMarkerConfiguration: NotRequired[ClusterMarkerConfigurationTypeDef], # (2)
HeatmapConfiguration: NotRequired[GeospatialHeatmapConfigurationTypeDef], # (3)
- See GeospatialSelectedPointStyleType
- See ClusterMarkerConfigurationTypeDef
- See GeospatialHeatmapConfigurationTypeDef
TableCellStyleTypeDef#
# TableCellStyleTypeDef definition
class TableCellStyleTypeDef(TypedDict):
Visibility: NotRequired[VisibilityType], # (1)
FontConfiguration: NotRequired[FontConfigurationTypeDef], # (2)
TextWrap: NotRequired[TextWrapType], # (3)
HorizontalTextAlignment: NotRequired[HorizontalTextAlignmentType], # (4)
VerticalTextAlignment: NotRequired[VerticalTextAlignmentType], # (5)
BackgroundColor: NotRequired[str],
Height: NotRequired[int],
Border: NotRequired[GlobalTableBorderOptionsTypeDef], # (6)
- See VisibilityType
- See FontConfigurationTypeDef
- See TextWrapType
- See HorizontalTextAlignmentType
- See VerticalTextAlignmentType
- See GlobalTableBorderOptionsTypeDef
ConditionalFormattingColorTypeDef#
# ConditionalFormattingColorTypeDef definition
class ConditionalFormattingColorTypeDef(TypedDict):
Solid: NotRequired[ConditionalFormattingSolidColorTypeDef], # (1)
Gradient: NotRequired[ConditionalFormattingGradientColorTypeDef], # (2)
DefaultInteractiveLayoutConfigurationTypeDef#
# DefaultInteractiveLayoutConfigurationTypeDef definition
class DefaultInteractiveLayoutConfigurationTypeDef(TypedDict):
Grid: NotRequired[DefaultGridLayoutConfigurationTypeDef], # (1)
FreeForm: NotRequired[DefaultFreeFormLayoutConfigurationTypeDef], # (2)
SheetControlLayoutConfigurationTypeDef#
# SheetControlLayoutConfigurationTypeDef definition
class SheetControlLayoutConfigurationTypeDef(TypedDict):
GridLayout: NotRequired[GridLayoutConfigurationTypeDef], # (1)
DataSetRefreshPropertiesTypeDef#
# DataSetRefreshPropertiesTypeDef definition
class DataSetRefreshPropertiesTypeDef(TypedDict):
RefreshConfiguration: RefreshConfigurationTypeDef, # (1)
SeriesItemTypeDef#
# SeriesItemTypeDef definition
class SeriesItemTypeDef(TypedDict):
FieldSeriesItem: NotRequired[FieldSeriesItemTypeDef], # (1)
DataFieldSeriesItem: NotRequired[DataFieldSeriesItemTypeDef], # (2)
ThemeConfigurationTypeDef#
# ThemeConfigurationTypeDef definition
class ThemeConfigurationTypeDef(TypedDict):
DataColorPalette: NotRequired[DataColorPaletteTypeDef], # (1)
UIColorPalette: NotRequired[UIColorPaletteTypeDef], # (2)
Sheet: NotRequired[SheetStyleTypeDef], # (3)
Typography: NotRequired[TypographyTypeDef], # (4)
ComparisonFormatConfigurationTypeDef#
# ComparisonFormatConfigurationTypeDef definition
class ComparisonFormatConfigurationTypeDef(TypedDict):
NumberDisplayFormatConfiguration: NotRequired[NumberDisplayFormatConfigurationTypeDef], # (1)
PercentageDisplayFormatConfiguration: NotRequired[PercentageDisplayFormatConfigurationTypeDef], # (2)
NumericFormatConfigurationTypeDef#
# NumericFormatConfigurationTypeDef definition
class NumericFormatConfigurationTypeDef(TypedDict):
NumberDisplayFormatConfiguration: NotRequired[NumberDisplayFormatConfigurationTypeDef], # (1)
CurrencyDisplayFormatConfiguration: NotRequired[CurrencyDisplayFormatConfigurationTypeDef], # (2)
PercentageDisplayFormatConfiguration: NotRequired[PercentageDisplayFormatConfigurationTypeDef], # (3)
- See NumberDisplayFormatConfigurationTypeDef
- See CurrencyDisplayFormatConfigurationTypeDef
- See PercentageDisplayFormatConfigurationTypeDef
AggregationSortConfigurationTypeDef#
# AggregationSortConfigurationTypeDef definition
class AggregationSortConfigurationTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
SortDirection: SortDirectionType, # (2)
AggregationFunction: NotRequired[AggregationFunctionTypeDef], # (3)
ColumnSortTypeDef#
# ColumnSortTypeDef definition
class ColumnSortTypeDef(TypedDict):
SortBy: ColumnIdentifierTypeDef, # (1)
Direction: SortDirectionType, # (2)
AggregationFunction: NotRequired[AggregationFunctionTypeDef], # (3)
ColumnTooltipItemTypeDef#
# ColumnTooltipItemTypeDef definition
class ColumnTooltipItemTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
Label: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (2)
Aggregation: NotRequired[AggregationFunctionTypeDef], # (3)
TooltipTarget: NotRequired[TooltipTargetType], # (4)
NumericEqualityFilterTypeDef#
# NumericEqualityFilterTypeDef definition
class NumericEqualityFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
MatchOperator: NumericEqualityMatchOperatorType, # (3)
NullOption: FilterNullOptionType, # (5)
Value: NotRequired[float],
SelectAllOptions: NotRequired[NumericFilterSelectAllOptionsType], # (2)
AggregationFunction: NotRequired[AggregationFunctionTypeDef], # (4)
ParameterName: NotRequired[str],
- See ColumnIdentifierTypeDef
- See NumericFilterSelectAllOptionsType
- See NumericEqualityMatchOperatorType
- See AggregationFunctionTypeDef
- See FilterNullOptionType
NumericRangeFilterTypeDef#
# NumericRangeFilterTypeDef definition
class NumericRangeFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
NullOption: FilterNullOptionType, # (6)
IncludeMinimum: NotRequired[bool],
IncludeMaximum: NotRequired[bool],
RangeMinimum: NotRequired[NumericRangeFilterValueTypeDef], # (2)
RangeMaximum: NotRequired[NumericRangeFilterValueTypeDef], # (2)
SelectAllOptions: NotRequired[NumericFilterSelectAllOptionsType], # (4)
AggregationFunction: NotRequired[AggregationFunctionTypeDef], # (5)
- See ColumnIdentifierTypeDef
- See NumericRangeFilterValueTypeDef
- See NumericRangeFilterValueTypeDef
- See NumericFilterSelectAllOptionsType
- See AggregationFunctionTypeDef
- See FilterNullOptionType
ReferenceLineDynamicDataConfigurationTypeDef#
# ReferenceLineDynamicDataConfigurationTypeDef definition
class ReferenceLineDynamicDataConfigurationTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
Calculation: NumericalAggregationFunctionTypeDef, # (3)
MeasureAggregationFunction: NotRequired[AggregationFunctionTypeDef], # (2)
TopicFilterTypeDef#
# TopicFilterTypeDef definition
class TopicFilterTypeDef(TypedDict):
FilterName: str,
OperandFieldName: str,
FilterDescription: NotRequired[str],
FilterClass: NotRequired[FilterClassType], # (1)
FilterSynonyms: NotRequired[Sequence[str]],
FilterType: NotRequired[NamedFilterTypeType], # (2)
CategoryFilter: NotRequired[TopicCategoryFilterTypeDef], # (3)
NumericEqualityFilter: NotRequired[TopicNumericEqualityFilterTypeDef], # (4)
NumericRangeFilter: NotRequired[TopicNumericRangeFilterTypeDef], # (5)
DateRangeFilter: NotRequired[TopicDateRangeFilterTypeDef], # (6)
RelativeDateFilter: NotRequired[TopicRelativeDateFilterTypeDef], # (7)
- See FilterClassType
- See NamedFilterTypeType
- See TopicCategoryFilterTypeDef
- See TopicNumericEqualityFilterTypeDef
- See TopicNumericRangeFilterTypeDef
- See TopicDateRangeFilterTypeDef
- See TopicRelativeDateFilterTypeDef
DataSourcePaginatorTypeDef#
# DataSourcePaginatorTypeDef definition
class DataSourcePaginatorTypeDef(TypedDict):
Arn: NotRequired[str],
DataSourceId: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[DataSourceTypeType], # (1)
Status: NotRequired[ResourceStatusType], # (2)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
DataSourceParameters: NotRequired[DataSourceParametersPaginatorTypeDef], # (3)
AlternateDataSourceParameters: NotRequired[List[DataSourceParametersPaginatorTypeDef]], # (4)
VpcConnectionProperties: NotRequired[VpcConnectionPropertiesTypeDef], # (5)
SslProperties: NotRequired[SslPropertiesTypeDef], # (6)
ErrorInfo: NotRequired[DataSourceErrorInfoTypeDef], # (7)
SecretArn: NotRequired[str],
- See DataSourceTypeType
- See ResourceStatusType
- See DataSourceParametersPaginatorTypeDef
- See DataSourceParametersPaginatorTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See DataSourceErrorInfoTypeDef
AssetBundleImportJobDataSourceOverrideParametersTypeDef#
# AssetBundleImportJobDataSourceOverrideParametersTypeDef definition
class AssetBundleImportJobDataSourceOverrideParametersTypeDef(TypedDict):
DataSourceId: str,
Name: NotRequired[str],
DataSourceParameters: NotRequired[DataSourceParametersTypeDef], # (1)
VpcConnectionProperties: NotRequired[VpcConnectionPropertiesTypeDef], # (2)
SslProperties: NotRequired[SslPropertiesTypeDef], # (3)
Credentials: NotRequired[AssetBundleImportJobDataSourceCredentialsTypeDef], # (4)
- See DataSourceParametersTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See AssetBundleImportJobDataSourceCredentialsTypeDef
CredentialPairTypeDef#
# CredentialPairTypeDef definition
class CredentialPairTypeDef(TypedDict):
Username: str,
Password: str,
AlternateDataSourceParameters: NotRequired[Sequence[DataSourceParametersTypeDef]], # (1)
DataSourceTypeDef#
# DataSourceTypeDef definition
class DataSourceTypeDef(TypedDict):
Arn: NotRequired[str],
DataSourceId: NotRequired[str],
Name: NotRequired[str],
Type: NotRequired[DataSourceTypeType], # (1)
Status: NotRequired[ResourceStatusType], # (2)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
DataSourceParameters: NotRequired[DataSourceParametersTypeDef], # (3)
AlternateDataSourceParameters: NotRequired[List[DataSourceParametersTypeDef]], # (4)
VpcConnectionProperties: NotRequired[VpcConnectionPropertiesTypeDef], # (5)
SslProperties: NotRequired[SslPropertiesTypeDef], # (6)
ErrorInfo: NotRequired[DataSourceErrorInfoTypeDef], # (7)
SecretArn: NotRequired[str],
- See DataSourceTypeType
- See ResourceStatusType
- See DataSourceParametersTypeDef
- See DataSourceParametersTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See DataSourceErrorInfoTypeDef
CreateRefreshScheduleRequestRequestTypeDef#
# CreateRefreshScheduleRequestRequestTypeDef definition
class CreateRefreshScheduleRequestRequestTypeDef(TypedDict):
DataSetId: str,
AwsAccountId: str,
Schedule: RefreshScheduleTypeDef, # (1)
DescribeRefreshScheduleResponseTypeDef#
# DescribeRefreshScheduleResponseTypeDef definition
class DescribeRefreshScheduleResponseTypeDef(TypedDict):
RefreshSchedule: RefreshScheduleTypeDef, # (1)
Status: int,
RequestId: str,
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListRefreshSchedulesResponseTypeDef#
# ListRefreshSchedulesResponseTypeDef definition
class ListRefreshSchedulesResponseTypeDef(TypedDict):
RefreshSchedules: List[RefreshScheduleTypeDef], # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateRefreshScheduleRequestRequestTypeDef#
# UpdateRefreshScheduleRequestRequestTypeDef definition
class UpdateRefreshScheduleRequestRequestTypeDef(TypedDict):
DataSetId: str,
AwsAccountId: str,
Schedule: RefreshScheduleTypeDef, # (1)
RegisteredUserEmbeddingExperienceConfigurationTypeDef#
# RegisteredUserEmbeddingExperienceConfigurationTypeDef definition
class RegisteredUserEmbeddingExperienceConfigurationTypeDef(TypedDict):
Dashboard: NotRequired[RegisteredUserDashboardEmbeddingConfigurationTypeDef], # (1)
QuickSightConsole: NotRequired[RegisteredUserQuickSightConsoleEmbeddingConfigurationTypeDef], # (2)
QSearchBar: NotRequired[RegisteredUserQSearchBarEmbeddingConfigurationTypeDef], # (3)
DashboardVisual: NotRequired[RegisteredUserDashboardVisualEmbeddingConfigurationTypeDef], # (4)
- See RegisteredUserDashboardEmbeddingConfigurationTypeDef
- See RegisteredUserQuickSightConsoleEmbeddingConfigurationTypeDef
- See RegisteredUserQSearchBarEmbeddingConfigurationTypeDef
- See RegisteredUserDashboardVisualEmbeddingConfigurationTypeDef
SnapshotJobResultFileGroupTypeDef#
# SnapshotJobResultFileGroupTypeDef definition
class SnapshotJobResultFileGroupTypeDef(TypedDict):
Files: NotRequired[List[SnapshotFileTypeDef]], # (1)
S3Results: NotRequired[List[SnapshotJobS3ResultTypeDef]], # (2)
DefaultSectionBasedLayoutConfigurationTypeDef#
# DefaultSectionBasedLayoutConfigurationTypeDef definition
class DefaultSectionBasedLayoutConfigurationTypeDef(TypedDict):
CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptionsTypeDef, # (1)
FreeFormLayoutConfigurationTypeDef#
# FreeFormLayoutConfigurationTypeDef definition
class FreeFormLayoutConfigurationTypeDef(TypedDict):
Elements: Sequence[FreeFormLayoutElementTypeDef], # (1)
CanvasSizeOptions: NotRequired[FreeFormLayoutCanvasSizeOptionsTypeDef], # (2)
FreeFormSectionLayoutConfigurationTypeDef#
# FreeFormSectionLayoutConfigurationTypeDef definition
class FreeFormSectionLayoutConfigurationTypeDef(TypedDict):
Elements: Sequence[FreeFormLayoutElementTypeDef], # (1)
SnapshotConfigurationTypeDef#
# SnapshotConfigurationTypeDef definition
class SnapshotConfigurationTypeDef(TypedDict):
FileGroups: List[SnapshotFileGroupTypeDef], # (1)
DestinationConfiguration: NotRequired[SnapshotDestinationConfigurationTypeDef], # (2)
Parameters: NotRequired[ParametersTypeDef], # (3)
ParameterDeclarationTypeDef#
# ParameterDeclarationTypeDef definition
class ParameterDeclarationTypeDef(TypedDict):
StringParameterDeclaration: NotRequired[StringParameterDeclarationTypeDef], # (1)
DecimalParameterDeclaration: NotRequired[DecimalParameterDeclarationTypeDef], # (2)
IntegerParameterDeclaration: NotRequired[IntegerParameterDeclarationTypeDef], # (3)
DateTimeParameterDeclaration: NotRequired[DateTimeParameterDeclarationTypeDef], # (4)
- See StringParameterDeclarationTypeDef
- See DecimalParameterDeclarationTypeDef
- See IntegerParameterDeclarationTypeDef
- See DateTimeParameterDeclarationTypeDef
DescribeDashboardResponseTypeDef#
# DescribeDashboardResponseTypeDef definition
class DescribeDashboardResponseTypeDef(TypedDict):
Dashboard: DashboardTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TemplateTypeDef#
# TemplateTypeDef definition
class TemplateTypeDef(TypedDict):
Arn: NotRequired[str],
Name: NotRequired[str],
Version: NotRequired[TemplateVersionTypeDef], # (1)
TemplateId: NotRequired[str],
LastUpdatedTime: NotRequired[datetime],
CreatedTime: NotRequired[datetime],
SetParameterValueConfigurationTypeDef#
# SetParameterValueConfigurationTypeDef definition
class SetParameterValueConfigurationTypeDef(TypedDict):
DestinationParameterName: str,
Value: DestinationParameterValueConfigurationTypeDef, # (1)
LogicalTableTypeDef#
# LogicalTableTypeDef definition
class LogicalTableTypeDef(TypedDict):
Alias: str,
Source: LogicalTableSourceTypeDef, # (2)
DataTransforms: NotRequired[Sequence[TransformOperationTypeDef]], # (1)
ColumnHierarchyTypeDef#
# ColumnHierarchyTypeDef definition
class ColumnHierarchyTypeDef(TypedDict):
ExplicitHierarchy: NotRequired[ExplicitHierarchyTypeDef], # (1)
DateTimeHierarchy: NotRequired[DateTimeHierarchyTypeDef], # (2)
PredefinedHierarchy: NotRequired[PredefinedHierarchyTypeDef], # (3)
PivotTableFieldOptionsTypeDef#
# PivotTableFieldOptionsTypeDef definition
class PivotTableFieldOptionsTypeDef(TypedDict):
SelectedFieldOptions: NotRequired[Sequence[PivotTableFieldOptionTypeDef]], # (1)
DataPathOptions: NotRequired[Sequence[PivotTableDataPathOptionTypeDef]], # (2)
CollapseStateOptions: NotRequired[Sequence[PivotTableFieldCollapseStateOptionTypeDef]], # (3)
- See PivotTableFieldOptionTypeDef
- See PivotTableDataPathOptionTypeDef
- See PivotTableFieldCollapseStateOptionTypeDef
AxisDisplayOptionsTypeDef#
# AxisDisplayOptionsTypeDef definition
class AxisDisplayOptionsTypeDef(TypedDict):
TickLabelOptions: NotRequired[AxisTickLabelOptionsTypeDef], # (1)
AxisLineVisibility: NotRequired[VisibilityType], # (2)
GridLineVisibility: NotRequired[VisibilityType], # (2)
DataOptions: NotRequired[AxisDataOptionsTypeDef], # (4)
ScrollbarOptions: NotRequired[ScrollBarOptionsTypeDef], # (5)
AxisOffset: NotRequired[str],
- See AxisTickLabelOptionsTypeDef
- See VisibilityType
- See VisibilityType
- See AxisDataOptionsTypeDef
- See ScrollBarOptionsTypeDef
FilterDateTimePickerControlTypeDef#
# FilterDateTimePickerControlTypeDef definition
class FilterDateTimePickerControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
DisplayOptions: NotRequired[DateTimePickerControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlDateTimePickerTypeType], # (2)
ParameterDateTimePickerControlTypeDef#
# ParameterDateTimePickerControlTypeDef definition
class ParameterDateTimePickerControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
DisplayOptions: NotRequired[DateTimePickerControlDisplayOptionsTypeDef], # (1)
FilterDropDownControlTypeDef#
# FilterDropDownControlTypeDef definition
class FilterDropDownControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
DisplayOptions: NotRequired[DropDownControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlListTypeType], # (2)
SelectableValues: NotRequired[FilterSelectableValuesTypeDef], # (3)
CascadingControlConfiguration: NotRequired[CascadingControlConfigurationTypeDef], # (4)
- See DropDownControlDisplayOptionsTypeDef
- See SheetControlListTypeType
- See FilterSelectableValuesTypeDef
- See CascadingControlConfigurationTypeDef
ParameterDropDownControlTypeDef#
# ParameterDropDownControlTypeDef definition
class ParameterDropDownControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
DisplayOptions: NotRequired[DropDownControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlListTypeType], # (2)
SelectableValues: NotRequired[ParameterSelectableValuesTypeDef], # (3)
CascadingControlConfiguration: NotRequired[CascadingControlConfigurationTypeDef], # (4)
- See DropDownControlDisplayOptionsTypeDef
- See SheetControlListTypeType
- See ParameterSelectableValuesTypeDef
- See CascadingControlConfigurationTypeDef
FilterListControlTypeDef#
# FilterListControlTypeDef definition
class FilterListControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
DisplayOptions: NotRequired[ListControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlListTypeType], # (2)
SelectableValues: NotRequired[FilterSelectableValuesTypeDef], # (3)
CascadingControlConfiguration: NotRequired[CascadingControlConfigurationTypeDef], # (4)
- See ListControlDisplayOptionsTypeDef
- See SheetControlListTypeType
- See FilterSelectableValuesTypeDef
- See CascadingControlConfigurationTypeDef
ParameterListControlTypeDef#
# ParameterListControlTypeDef definition
class ParameterListControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
DisplayOptions: NotRequired[ListControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlListTypeType], # (2)
SelectableValues: NotRequired[ParameterSelectableValuesTypeDef], # (3)
CascadingControlConfiguration: NotRequired[CascadingControlConfigurationTypeDef], # (4)
- See ListControlDisplayOptionsTypeDef
- See SheetControlListTypeType
- See ParameterSelectableValuesTypeDef
- See CascadingControlConfigurationTypeDef
FilterRelativeDateTimeControlTypeDef#
# FilterRelativeDateTimeControlTypeDef definition
class FilterRelativeDateTimeControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
DisplayOptions: NotRequired[RelativeDateTimeControlDisplayOptionsTypeDef], # (1)
FilterSliderControlTypeDef#
# FilterSliderControlTypeDef definition
class FilterSliderControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
MaximumValue: float,
MinimumValue: float,
StepSize: float,
DisplayOptions: NotRequired[SliderControlDisplayOptionsTypeDef], # (1)
Type: NotRequired[SheetControlSliderTypeType], # (2)
ParameterSliderControlTypeDef#
# ParameterSliderControlTypeDef definition
class ParameterSliderControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
MaximumValue: float,
MinimumValue: float,
StepSize: float,
DisplayOptions: NotRequired[SliderControlDisplayOptionsTypeDef], # (1)
FilterTextAreaControlTypeDef#
# FilterTextAreaControlTypeDef definition
class FilterTextAreaControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
Delimiter: NotRequired[str],
DisplayOptions: NotRequired[TextAreaControlDisplayOptionsTypeDef], # (1)
ParameterTextAreaControlTypeDef#
# ParameterTextAreaControlTypeDef definition
class ParameterTextAreaControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
Delimiter: NotRequired[str],
DisplayOptions: NotRequired[TextAreaControlDisplayOptionsTypeDef], # (1)
FilterTextFieldControlTypeDef#
# FilterTextFieldControlTypeDef definition
class FilterTextFieldControlTypeDef(TypedDict):
FilterControlId: str,
Title: str,
SourceFilterId: str,
DisplayOptions: NotRequired[TextFieldControlDisplayOptionsTypeDef], # (1)
ParameterTextFieldControlTypeDef#
# ParameterTextFieldControlTypeDef definition
class ParameterTextFieldControlTypeDef(TypedDict):
ParameterControlId: str,
Title: str,
SourceParameterName: str,
DisplayOptions: NotRequired[TextFieldControlDisplayOptionsTypeDef], # (1)
SmallMultiplesOptionsTypeDef#
# SmallMultiplesOptionsTypeDef definition
class SmallMultiplesOptionsTypeDef(TypedDict):
MaxVisibleRows: NotRequired[int],
MaxVisibleColumns: NotRequired[int],
PanelConfiguration: NotRequired[PanelConfigurationTypeDef], # (1)
XAxis: NotRequired[SmallMultiplesAxisPropertiesTypeDef], # (2)
YAxis: NotRequired[SmallMultiplesAxisPropertiesTypeDef], # (2)
- See PanelConfigurationTypeDef
- See SmallMultiplesAxisPropertiesTypeDef
- See SmallMultiplesAxisPropertiesTypeDef
TableFieldLinkConfigurationTypeDef#
# TableFieldLinkConfigurationTypeDef definition
class TableFieldLinkConfigurationTypeDef(TypedDict):
Target: URLTargetConfigurationType, # (1)
Content: TableFieldLinkContentConfigurationTypeDef, # (2)
PivotTableOptionsTypeDef#
# PivotTableOptionsTypeDef definition
class PivotTableOptionsTypeDef(TypedDict):
MetricPlacement: NotRequired[PivotTableMetricPlacementType], # (1)
SingleMetricVisibility: NotRequired[VisibilityType], # (2)
ColumnNamesVisibility: NotRequired[VisibilityType], # (2)
ToggleButtonsVisibility: NotRequired[VisibilityType], # (2)
ColumnHeaderStyle: NotRequired[TableCellStyleTypeDef], # (5)
RowHeaderStyle: NotRequired[TableCellStyleTypeDef], # (5)
CellStyle: NotRequired[TableCellStyleTypeDef], # (5)
RowFieldNamesStyle: NotRequired[TableCellStyleTypeDef], # (5)
RowAlternateColorOptions: NotRequired[RowAlternateColorOptionsTypeDef], # (9)
CollapsedRowDimensionsVisibility: NotRequired[VisibilityType], # (2)
RowsLayout: NotRequired[PivotTableRowsLayoutType], # (11)
RowsLabelOptions: NotRequired[PivotTableRowsLabelOptionsTypeDef], # (12)
DefaultCellWidth: NotRequired[str],
- See PivotTableMetricPlacementType
- See VisibilityType
- See VisibilityType
- See VisibilityType
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See RowAlternateColorOptionsTypeDef
- See VisibilityType
- See PivotTableRowsLayoutType
- See PivotTableRowsLabelOptionsTypeDef
PivotTotalOptionsTypeDef#
# PivotTotalOptionsTypeDef definition
class PivotTotalOptionsTypeDef(TypedDict):
TotalsVisibility: NotRequired[VisibilityType], # (1)
Placement: NotRequired[TableTotalsPlacementType], # (2)
ScrollStatus: NotRequired[TableTotalsScrollStatusType], # (3)
CustomLabel: NotRequired[str],
TotalCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
ValueCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
MetricHeaderCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
TotalAggregationOptions: NotRequired[Sequence[TotalAggregationOptionTypeDef]], # (7)
- See VisibilityType
- See TableTotalsPlacementType
- See TableTotalsScrollStatusType
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TotalAggregationOptionTypeDef
SubtotalOptionsTypeDef#
# SubtotalOptionsTypeDef definition
class SubtotalOptionsTypeDef(TypedDict):
TotalsVisibility: NotRequired[VisibilityType], # (1)
CustomLabel: NotRequired[str],
FieldLevel: NotRequired[PivotTableSubtotalLevelType], # (2)
FieldLevelOptions: NotRequired[Sequence[PivotTableFieldSubtotalOptionsTypeDef]], # (3)
TotalCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
ValueCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
MetricHeaderCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
StyleTargets: NotRequired[Sequence[TableStyleTargetTypeDef]], # (7)
- See VisibilityType
- See PivotTableSubtotalLevelType
- See PivotTableFieldSubtotalOptionsTypeDef
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See TableStyleTargetTypeDef
TableOptionsTypeDef#
# TableOptionsTypeDef definition
class TableOptionsTypeDef(TypedDict):
Orientation: NotRequired[TableOrientationType], # (1)
HeaderStyle: NotRequired[TableCellStyleTypeDef], # (2)
CellStyle: NotRequired[TableCellStyleTypeDef], # (2)
RowAlternateColorOptions: NotRequired[RowAlternateColorOptionsTypeDef], # (4)
- See TableOrientationType
- See TableCellStyleTypeDef
- See TableCellStyleTypeDef
- See RowAlternateColorOptionsTypeDef
TotalOptionsTypeDef#
# TotalOptionsTypeDef definition
class TotalOptionsTypeDef(TypedDict):
TotalsVisibility: NotRequired[VisibilityType], # (1)
Placement: NotRequired[TableTotalsPlacementType], # (2)
ScrollStatus: NotRequired[TableTotalsScrollStatusType], # (3)
CustomLabel: NotRequired[str],
TotalCellStyle: NotRequired[TableCellStyleTypeDef], # (4)
TotalAggregationOptions: NotRequired[Sequence[TotalAggregationOptionTypeDef]], # (5)
- See VisibilityType
- See TableTotalsPlacementType
- See TableTotalsScrollStatusType
- See TableCellStyleTypeDef
- See TotalAggregationOptionTypeDef
GaugeChartArcConditionalFormattingTypeDef#
# GaugeChartArcConditionalFormattingTypeDef definition
class GaugeChartArcConditionalFormattingTypeDef(TypedDict):
ForegroundColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
GaugeChartPrimaryValueConditionalFormattingTypeDef#
# GaugeChartPrimaryValueConditionalFormattingTypeDef definition
class GaugeChartPrimaryValueConditionalFormattingTypeDef(TypedDict):
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
Icon: NotRequired[ConditionalFormattingIconTypeDef], # (2)
KPIActualValueConditionalFormattingTypeDef#
# KPIActualValueConditionalFormattingTypeDef definition
class KPIActualValueConditionalFormattingTypeDef(TypedDict):
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
Icon: NotRequired[ConditionalFormattingIconTypeDef], # (2)
KPIComparisonValueConditionalFormattingTypeDef#
# KPIComparisonValueConditionalFormattingTypeDef definition
class KPIComparisonValueConditionalFormattingTypeDef(TypedDict):
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
Icon: NotRequired[ConditionalFormattingIconTypeDef], # (2)
KPIPrimaryValueConditionalFormattingTypeDef#
# KPIPrimaryValueConditionalFormattingTypeDef definition
class KPIPrimaryValueConditionalFormattingTypeDef(TypedDict):
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
Icon: NotRequired[ConditionalFormattingIconTypeDef], # (2)
KPIProgressBarConditionalFormattingTypeDef#
# KPIProgressBarConditionalFormattingTypeDef definition
class KPIProgressBarConditionalFormattingTypeDef(TypedDict):
ForegroundColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
ShapeConditionalFormatTypeDef#
# ShapeConditionalFormatTypeDef definition
class ShapeConditionalFormatTypeDef(TypedDict):
BackgroundColor: ConditionalFormattingColorTypeDef, # (1)
TableRowConditionalFormattingTypeDef#
# TableRowConditionalFormattingTypeDef definition
class TableRowConditionalFormattingTypeDef(TypedDict):
BackgroundColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
TextConditionalFormatTypeDef#
# TextConditionalFormatTypeDef definition
class TextConditionalFormatTypeDef(TypedDict):
BackgroundColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
TextColor: NotRequired[ConditionalFormattingColorTypeDef], # (1)
Icon: NotRequired[ConditionalFormattingIconTypeDef], # (3)
- See ConditionalFormattingColorTypeDef
- See ConditionalFormattingColorTypeDef
- See ConditionalFormattingIconTypeDef
SheetControlLayoutTypeDef#
# SheetControlLayoutTypeDef definition
class SheetControlLayoutTypeDef(TypedDict):
Configuration: SheetControlLayoutConfigurationTypeDef, # (1)
DescribeDataSetRefreshPropertiesResponseTypeDef#
# DescribeDataSetRefreshPropertiesResponseTypeDef definition
class DescribeDataSetRefreshPropertiesResponseTypeDef(TypedDict):
RequestId: str,
Status: int,
DataSetRefreshProperties: DataSetRefreshPropertiesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutDataSetRefreshPropertiesRequestRequestTypeDef#
# PutDataSetRefreshPropertiesRequestRequestTypeDef definition
class PutDataSetRefreshPropertiesRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
DataSetRefreshProperties: DataSetRefreshPropertiesTypeDef, # (1)
CreateThemeRequestRequestTypeDef#
# CreateThemeRequestRequestTypeDef definition
class CreateThemeRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
Name: str,
BaseThemeId: str,
Configuration: ThemeConfigurationTypeDef, # (1)
VersionDescription: NotRequired[str],
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
ThemeVersionTypeDef#
# ThemeVersionTypeDef definition
class ThemeVersionTypeDef(TypedDict):
VersionNumber: NotRequired[int],
Arn: NotRequired[str],
Description: NotRequired[str],
BaseThemeId: NotRequired[str],
CreatedTime: NotRequired[datetime],
Configuration: NotRequired[ThemeConfigurationTypeDef], # (1)
Errors: NotRequired[List[ThemeErrorTypeDef]], # (2)
Status: NotRequired[ResourceStatusType], # (3)
UpdateThemeRequestRequestTypeDef#
# UpdateThemeRequestRequestTypeDef definition
class UpdateThemeRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
ThemeId: str,
BaseThemeId: str,
Name: NotRequired[str],
VersionDescription: NotRequired[str],
Configuration: NotRequired[ThemeConfigurationTypeDef], # (1)
ComparisonConfigurationTypeDef#
# ComparisonConfigurationTypeDef definition
class ComparisonConfigurationTypeDef(TypedDict):
ComparisonMethod: NotRequired[ComparisonMethodType], # (1)
ComparisonFormat: NotRequired[ComparisonFormatConfigurationTypeDef], # (2)
DateTimeFormatConfigurationTypeDef#
# DateTimeFormatConfigurationTypeDef definition
class DateTimeFormatConfigurationTypeDef(TypedDict):
DateTimeFormat: NotRequired[str],
NullValueFormatConfiguration: NotRequired[NullValueFormatConfigurationTypeDef], # (1)
NumericFormatConfiguration: NotRequired[NumericFormatConfigurationTypeDef], # (2)
NumberFormatConfigurationTypeDef#
# NumberFormatConfigurationTypeDef definition
class NumberFormatConfigurationTypeDef(TypedDict):
FormatConfiguration: NotRequired[NumericFormatConfigurationTypeDef], # (1)
ReferenceLineValueLabelConfigurationTypeDef#
# ReferenceLineValueLabelConfigurationTypeDef definition
class ReferenceLineValueLabelConfigurationTypeDef(TypedDict):
RelativePosition: NotRequired[ReferenceLineValueLabelRelativePositionType], # (1)
FormatConfiguration: NotRequired[NumericFormatConfigurationTypeDef], # (2)
StringFormatConfigurationTypeDef#
# StringFormatConfigurationTypeDef definition
class StringFormatConfigurationTypeDef(TypedDict):
NullValueFormatConfiguration: NotRequired[NullValueFormatConfigurationTypeDef], # (1)
NumericFormatConfiguration: NotRequired[NumericFormatConfigurationTypeDef], # (2)
TopBottomFilterTypeDef#
# TopBottomFilterTypeDef definition
class TopBottomFilterTypeDef(TypedDict):
FilterId: str,
Column: ColumnIdentifierTypeDef, # (1)
AggregationSortConfigurations: Sequence[AggregationSortConfigurationTypeDef], # (2)
Limit: NotRequired[int],
TimeGranularity: NotRequired[TimeGranularityType], # (3)
ParameterName: NotRequired[str],
FieldSortOptionsTypeDef#
# FieldSortOptionsTypeDef definition
class FieldSortOptionsTypeDef(TypedDict):
FieldSort: NotRequired[FieldSortTypeDef], # (1)
ColumnSort: NotRequired[ColumnSortTypeDef], # (2)
- See FieldSortTypeDef
- See ColumnSortTypeDef
PivotTableSortByTypeDef#
# PivotTableSortByTypeDef definition
class PivotTableSortByTypeDef(TypedDict):
Field: NotRequired[FieldSortTypeDef], # (1)
Column: NotRequired[ColumnSortTypeDef], # (2)
DataPath: NotRequired[DataPathSortTypeDef], # (3)
- See FieldSortTypeDef
- See ColumnSortTypeDef
- See DataPathSortTypeDef
TooltipItemTypeDef#
# TooltipItemTypeDef definition
class TooltipItemTypeDef(TypedDict):
FieldTooltipItem: NotRequired[FieldTooltipItemTypeDef], # (1)
ColumnTooltipItem: NotRequired[ColumnTooltipItemTypeDef], # (2)
ReferenceLineDataConfigurationTypeDef#
# ReferenceLineDataConfigurationTypeDef definition
class ReferenceLineDataConfigurationTypeDef(TypedDict):
StaticConfiguration: NotRequired[ReferenceLineStaticDataConfigurationTypeDef], # (1)
DynamicConfiguration: NotRequired[ReferenceLineDynamicDataConfigurationTypeDef], # (2)
AxisBinding: NotRequired[AxisBindingType], # (3)
SeriesType: NotRequired[ReferenceLineSeriesTypeType], # (4)
- See ReferenceLineStaticDataConfigurationTypeDef
- See ReferenceLineDynamicDataConfigurationTypeDef
- See AxisBindingType
- See ReferenceLineSeriesTypeType
DatasetMetadataTypeDef#
# DatasetMetadataTypeDef definition
class DatasetMetadataTypeDef(TypedDict):
DatasetArn: str,
DatasetName: NotRequired[str],
DatasetDescription: NotRequired[str],
DataAggregation: NotRequired[DataAggregationTypeDef], # (1)
Filters: NotRequired[Sequence[TopicFilterTypeDef]], # (2)
Columns: NotRequired[Sequence[TopicColumnTypeDef]], # (3)
CalculatedFields: NotRequired[Sequence[TopicCalculatedFieldTypeDef]], # (4)
NamedEntities: NotRequired[Sequence[TopicNamedEntityTypeDef]], # (5)
- See DataAggregationTypeDef
- See TopicFilterTypeDef
- See TopicColumnTypeDef
- See TopicCalculatedFieldTypeDef
- See TopicNamedEntityTypeDef
ListDataSourcesResponsePaginatorTypeDef#
# ListDataSourcesResponsePaginatorTypeDef definition
class ListDataSourcesResponsePaginatorTypeDef(TypedDict):
DataSources: List[DataSourcePaginatorTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AssetBundleImportJobOverrideParametersTypeDef#
# AssetBundleImportJobOverrideParametersTypeDef definition
class AssetBundleImportJobOverrideParametersTypeDef(TypedDict):
ResourceIdOverrideConfiguration: NotRequired[AssetBundleImportJobResourceIdOverrideConfigurationTypeDef], # (1)
VPCConnections: NotRequired[List[AssetBundleImportJobVPCConnectionOverrideParametersTypeDef]], # (2)
RefreshSchedules: NotRequired[List[AssetBundleImportJobRefreshScheduleOverrideParametersTypeDef]], # (3)
DataSources: NotRequired[List[AssetBundleImportJobDataSourceOverrideParametersTypeDef]], # (4)
DataSets: NotRequired[List[AssetBundleImportJobDataSetOverrideParametersTypeDef]], # (5)
Themes: NotRequired[List[AssetBundleImportJobThemeOverrideParametersTypeDef]], # (6)
Analyses: NotRequired[List[AssetBundleImportJobAnalysisOverrideParametersTypeDef]], # (7)
Dashboards: NotRequired[List[AssetBundleImportJobDashboardOverrideParametersTypeDef]], # (8)
- See AssetBundleImportJobResourceIdOverrideConfigurationTypeDef
- See AssetBundleImportJobVPCConnectionOverrideParametersTypeDef
- See AssetBundleImportJobRefreshScheduleOverrideParametersTypeDef
- See AssetBundleImportJobDataSourceOverrideParametersTypeDef
- See AssetBundleImportJobDataSetOverrideParametersTypeDef
- See AssetBundleImportJobThemeOverrideParametersTypeDef
- See AssetBundleImportJobAnalysisOverrideParametersTypeDef
- See AssetBundleImportJobDashboardOverrideParametersTypeDef
DataSourceCredentialsTypeDef#
# DataSourceCredentialsTypeDef definition
class DataSourceCredentialsTypeDef(TypedDict):
CredentialPair: NotRequired[CredentialPairTypeDef], # (1)
CopySourceArn: NotRequired[str],
SecretArn: NotRequired[str],
DescribeDataSourceResponseTypeDef#
# DescribeDataSourceResponseTypeDef definition
class DescribeDataSourceResponseTypeDef(TypedDict):
DataSource: DataSourceTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
DataSources: List[DataSourceTypeDef], # (1)
NextToken: str,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef#
# GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef definition
class GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
UserArn: str,
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfigurationTypeDef, # (1)
SessionLifetimeInMinutes: NotRequired[int],
AllowedDomains: NotRequired[Sequence[str]],
AnonymousUserSnapshotJobResultTypeDef#
# AnonymousUserSnapshotJobResultTypeDef definition
class AnonymousUserSnapshotJobResultTypeDef(TypedDict):
FileGroups: NotRequired[List[SnapshotJobResultFileGroupTypeDef]], # (1)
DefaultPaginatedLayoutConfigurationTypeDef#
# DefaultPaginatedLayoutConfigurationTypeDef definition
class DefaultPaginatedLayoutConfigurationTypeDef(TypedDict):
SectionBased: NotRequired[DefaultSectionBasedLayoutConfigurationTypeDef], # (1)
SectionLayoutConfigurationTypeDef#
# SectionLayoutConfigurationTypeDef definition
class SectionLayoutConfigurationTypeDef(TypedDict):
FreeFormLayout: FreeFormSectionLayoutConfigurationTypeDef, # (1)
DescribeDashboardSnapshotJobResponseTypeDef#
# DescribeDashboardSnapshotJobResponseTypeDef definition
class DescribeDashboardSnapshotJobResponseTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
UserConfiguration: SnapshotUserConfigurationRedactedTypeDef, # (1)
SnapshotConfiguration: SnapshotConfigurationTypeDef, # (2)
Arn: str,
JobStatus: SnapshotJobStatusType, # (3)
CreatedTime: datetime,
LastUpdatedTime: datetime,
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See SnapshotUserConfigurationRedactedTypeDef
- See SnapshotConfigurationTypeDef
- See SnapshotJobStatusType
- See ResponseMetadataTypeDef
StartDashboardSnapshotJobRequestRequestTypeDef#
# StartDashboardSnapshotJobRequestRequestTypeDef definition
class StartDashboardSnapshotJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
UserConfiguration: SnapshotUserConfigurationTypeDef, # (1)
SnapshotConfiguration: SnapshotConfigurationTypeDef, # (2)
DescribeTemplateResponseTypeDef#
# DescribeTemplateResponseTypeDef definition
class DescribeTemplateResponseTypeDef(TypedDict):
Template: TemplateTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CustomActionSetParametersOperationTypeDef#
# CustomActionSetParametersOperationTypeDef definition
class CustomActionSetParametersOperationTypeDef(TypedDict):
ParameterValueConfigurations: Sequence[SetParameterValueConfigurationTypeDef], # (1)
CreateDataSetRequestRequestTypeDef#
# CreateDataSetRequestRequestTypeDef definition
class CreateDataSetRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
Name: str,
PhysicalTableMap: Mapping[str, PhysicalTableTypeDef], # (1)
ImportMode: DataSetImportModeType, # (2)
LogicalTableMap: NotRequired[Mapping[str, LogicalTableTypeDef]], # (3)
ColumnGroups: NotRequired[Sequence[ColumnGroupTypeDef]], # (4)
FieldFolders: NotRequired[Mapping[str, FieldFolderTypeDef]], # (5)
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (6)
RowLevelPermissionDataSet: NotRequired[RowLevelPermissionDataSetTypeDef], # (7)
RowLevelPermissionTagConfiguration: NotRequired[RowLevelPermissionTagConfigurationTypeDef], # (8)
ColumnLevelPermissionRules: NotRequired[Sequence[ColumnLevelPermissionRuleTypeDef]], # (9)
Tags: NotRequired[Sequence[TagTypeDef]], # (10)
DataSetUsageConfiguration: NotRequired[DataSetUsageConfigurationTypeDef], # (11)
DatasetParameters: NotRequired[Sequence[DatasetParameterTypeDef]], # (12)
FolderArns: NotRequired[Sequence[str]],
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See ResourcePermissionTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See TagTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef
DataSetTypeDef#
# DataSetTypeDef definition
class DataSetTypeDef(TypedDict):
Arn: NotRequired[str],
DataSetId: NotRequired[str],
Name: NotRequired[str],
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
PhysicalTableMap: NotRequired[Dict[str, PhysicalTableTypeDef]], # (1)
LogicalTableMap: NotRequired[Dict[str, LogicalTableTypeDef]], # (2)
OutputColumns: NotRequired[List[OutputColumnTypeDef]], # (3)
ImportMode: NotRequired[DataSetImportModeType], # (4)
ConsumedSpiceCapacityInBytes: NotRequired[int],
ColumnGroups: NotRequired[List[ColumnGroupTypeDef]], # (5)
FieldFolders: NotRequired[Dict[str, FieldFolderTypeDef]], # (6)
RowLevelPermissionDataSet: NotRequired[RowLevelPermissionDataSetTypeDef], # (7)
RowLevelPermissionTagConfiguration: NotRequired[RowLevelPermissionTagConfigurationTypeDef], # (8)
ColumnLevelPermissionRules: NotRequired[List[ColumnLevelPermissionRuleTypeDef]], # (9)
DataSetUsageConfiguration: NotRequired[DataSetUsageConfigurationTypeDef], # (10)
DatasetParameters: NotRequired[List[DatasetParameterTypeDef]], # (11)
- See PhysicalTableTypeDef
- See LogicalTableTypeDef
- See OutputColumnTypeDef
- See DataSetImportModeType
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef
UpdateDataSetRequestRequestTypeDef#
# UpdateDataSetRequestRequestTypeDef definition
class UpdateDataSetRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSetId: str,
Name: str,
PhysicalTableMap: Mapping[str, PhysicalTableTypeDef], # (1)
ImportMode: DataSetImportModeType, # (2)
LogicalTableMap: NotRequired[Mapping[str, LogicalTableTypeDef]], # (3)
ColumnGroups: NotRequired[Sequence[ColumnGroupTypeDef]], # (4)
FieldFolders: NotRequired[Mapping[str, FieldFolderTypeDef]], # (5)
RowLevelPermissionDataSet: NotRequired[RowLevelPermissionDataSetTypeDef], # (6)
RowLevelPermissionTagConfiguration: NotRequired[RowLevelPermissionTagConfigurationTypeDef], # (7)
ColumnLevelPermissionRules: NotRequired[Sequence[ColumnLevelPermissionRuleTypeDef]], # (8)
DataSetUsageConfiguration: NotRequired[DataSetUsageConfigurationTypeDef], # (9)
DatasetParameters: NotRequired[Sequence[DatasetParameterTypeDef]], # (10)
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef
LineSeriesAxisDisplayOptionsTypeDef#
# LineSeriesAxisDisplayOptionsTypeDef definition
class LineSeriesAxisDisplayOptionsTypeDef(TypedDict):
AxisOptions: NotRequired[AxisDisplayOptionsTypeDef], # (1)
MissingDataConfigurations: NotRequired[Sequence[MissingDataConfigurationTypeDef]], # (2)
FilterControlTypeDef#
# FilterControlTypeDef definition
class FilterControlTypeDef(TypedDict):
DateTimePicker: NotRequired[FilterDateTimePickerControlTypeDef], # (1)
List: NotRequired[FilterListControlTypeDef], # (2)
Dropdown: NotRequired[FilterDropDownControlTypeDef], # (3)
TextField: NotRequired[FilterTextFieldControlTypeDef], # (4)
TextArea: NotRequired[FilterTextAreaControlTypeDef], # (5)
Slider: NotRequired[FilterSliderControlTypeDef], # (6)
RelativeDateTime: NotRequired[FilterRelativeDateTimeControlTypeDef], # (7)
- See FilterDateTimePickerControlTypeDef
- See FilterListControlTypeDef
- See FilterDropDownControlTypeDef
- See FilterTextFieldControlTypeDef
- See FilterTextAreaControlTypeDef
- See FilterSliderControlTypeDef
- See FilterRelativeDateTimeControlTypeDef
ParameterControlTypeDef#
# ParameterControlTypeDef definition
class ParameterControlTypeDef(TypedDict):
DateTimePicker: NotRequired[ParameterDateTimePickerControlTypeDef], # (1)
List: NotRequired[ParameterListControlTypeDef], # (2)
Dropdown: NotRequired[ParameterDropDownControlTypeDef], # (3)
TextField: NotRequired[ParameterTextFieldControlTypeDef], # (4)
TextArea: NotRequired[ParameterTextAreaControlTypeDef], # (5)
Slider: NotRequired[ParameterSliderControlTypeDef], # (6)
- See ParameterDateTimePickerControlTypeDef
- See ParameterListControlTypeDef
- See ParameterDropDownControlTypeDef
- See ParameterTextFieldControlTypeDef
- See ParameterTextAreaControlTypeDef
- See ParameterSliderControlTypeDef
TableFieldURLConfigurationTypeDef#
# TableFieldURLConfigurationTypeDef definition
class TableFieldURLConfigurationTypeDef(TypedDict):
LinkConfiguration: NotRequired[TableFieldLinkConfigurationTypeDef], # (1)
ImageConfiguration: NotRequired[TableFieldImageConfigurationTypeDef], # (2)
PivotTableTotalOptionsTypeDef#
# PivotTableTotalOptionsTypeDef definition
class PivotTableTotalOptionsTypeDef(TypedDict):
RowSubtotalOptions: NotRequired[SubtotalOptionsTypeDef], # (1)
ColumnSubtotalOptions: NotRequired[SubtotalOptionsTypeDef], # (1)
RowTotalOptions: NotRequired[PivotTotalOptionsTypeDef], # (3)
ColumnTotalOptions: NotRequired[PivotTotalOptionsTypeDef], # (3)
- See SubtotalOptionsTypeDef
- See SubtotalOptionsTypeDef
- See PivotTotalOptionsTypeDef
- See PivotTotalOptionsTypeDef
GaugeChartConditionalFormattingOptionTypeDef#
# GaugeChartConditionalFormattingOptionTypeDef definition
class GaugeChartConditionalFormattingOptionTypeDef(TypedDict):
PrimaryValue: NotRequired[GaugeChartPrimaryValueConditionalFormattingTypeDef], # (1)
Arc: NotRequired[GaugeChartArcConditionalFormattingTypeDef], # (2)
- See GaugeChartPrimaryValueConditionalFormattingTypeDef
- See GaugeChartArcConditionalFormattingTypeDef
KPIConditionalFormattingOptionTypeDef#
# KPIConditionalFormattingOptionTypeDef definition
class KPIConditionalFormattingOptionTypeDef(TypedDict):
PrimaryValue: NotRequired[KPIPrimaryValueConditionalFormattingTypeDef], # (1)
ProgressBar: NotRequired[KPIProgressBarConditionalFormattingTypeDef], # (2)
ActualValue: NotRequired[KPIActualValueConditionalFormattingTypeDef], # (3)
ComparisonValue: NotRequired[KPIComparisonValueConditionalFormattingTypeDef], # (4)
- See KPIPrimaryValueConditionalFormattingTypeDef
- See KPIProgressBarConditionalFormattingTypeDef
- See KPIActualValueConditionalFormattingTypeDef
- See KPIComparisonValueConditionalFormattingTypeDef
FilledMapShapeConditionalFormattingTypeDef#
# FilledMapShapeConditionalFormattingTypeDef definition
class FilledMapShapeConditionalFormattingTypeDef(TypedDict):
FieldId: str,
Format: NotRequired[ShapeConditionalFormatTypeDef], # (1)
PivotTableCellConditionalFormattingTypeDef#
# PivotTableCellConditionalFormattingTypeDef definition
class PivotTableCellConditionalFormattingTypeDef(TypedDict):
FieldId: str,
TextFormat: NotRequired[TextConditionalFormatTypeDef], # (1)
Scope: NotRequired[PivotTableConditionalFormattingScopeTypeDef], # (2)
Scopes: NotRequired[Sequence[PivotTableConditionalFormattingScopeTypeDef]], # (3)
- See TextConditionalFormatTypeDef
- See PivotTableConditionalFormattingScopeTypeDef
- See PivotTableConditionalFormattingScopeTypeDef
TableCellConditionalFormattingTypeDef#
# TableCellConditionalFormattingTypeDef definition
class TableCellConditionalFormattingTypeDef(TypedDict):
FieldId: str,
TextFormat: NotRequired[TextConditionalFormatTypeDef], # (1)
ThemeTypeDef#
# ThemeTypeDef definition
class ThemeTypeDef(TypedDict):
Arn: NotRequired[str],
Name: NotRequired[str],
ThemeId: NotRequired[str],
Version: NotRequired[ThemeVersionTypeDef], # (1)
CreatedTime: NotRequired[datetime],
LastUpdatedTime: NotRequired[datetime],
Type: NotRequired[ThemeTypeType], # (2)
- See ThemeVersionTypeDef
- See ThemeTypeType
GaugeChartOptionsTypeDef#
# GaugeChartOptionsTypeDef definition
class GaugeChartOptionsTypeDef(TypedDict):
PrimaryValueDisplayType: NotRequired[PrimaryValueDisplayTypeType], # (1)
Comparison: NotRequired[ComparisonConfigurationTypeDef], # (2)
ArcAxis: NotRequired[ArcAxisConfigurationTypeDef], # (3)
Arc: NotRequired[ArcConfigurationTypeDef], # (4)
PrimaryValueFontConfiguration: NotRequired[FontConfigurationTypeDef], # (5)
- See PrimaryValueDisplayTypeType
- See ComparisonConfigurationTypeDef
- See ArcAxisConfigurationTypeDef
- See ArcConfigurationTypeDef
- See FontConfigurationTypeDef
KPIOptionsTypeDef#
# KPIOptionsTypeDef definition
class KPIOptionsTypeDef(TypedDict):
ProgressBar: NotRequired[ProgressBarOptionsTypeDef], # (1)
TrendArrows: NotRequired[TrendArrowOptionsTypeDef], # (2)
SecondaryValue: NotRequired[SecondaryValueOptionsTypeDef], # (3)
Comparison: NotRequired[ComparisonConfigurationTypeDef], # (4)
PrimaryValueDisplayType: NotRequired[PrimaryValueDisplayTypeType], # (5)
PrimaryValueFontConfiguration: NotRequired[FontConfigurationTypeDef], # (6)
SecondaryValueFontConfiguration: NotRequired[FontConfigurationTypeDef], # (6)
Sparkline: NotRequired[KPISparklineOptionsTypeDef], # (8)
VisualLayoutOptions: NotRequired[KPIVisualLayoutOptionsTypeDef], # (9)
- See ProgressBarOptionsTypeDef
- See TrendArrowOptionsTypeDef
- See SecondaryValueOptionsTypeDef
- See ComparisonConfigurationTypeDef
- See PrimaryValueDisplayTypeType
- See FontConfigurationTypeDef
- See FontConfigurationTypeDef
- See KPISparklineOptionsTypeDef
- See KPIVisualLayoutOptionsTypeDef
DateDimensionFieldTypeDef#
# DateDimensionFieldTypeDef definition
class DateDimensionFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
DateGranularity: NotRequired[TimeGranularityType], # (2)
HierarchyId: NotRequired[str],
FormatConfiguration: NotRequired[DateTimeFormatConfigurationTypeDef], # (3)
DateMeasureFieldTypeDef#
# DateMeasureFieldTypeDef definition
class DateMeasureFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
AggregationFunction: NotRequired[DateAggregationFunctionType], # (2)
FormatConfiguration: NotRequired[DateTimeFormatConfigurationTypeDef], # (3)
NumericalDimensionFieldTypeDef#
# NumericalDimensionFieldTypeDef definition
class NumericalDimensionFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
HierarchyId: NotRequired[str],
FormatConfiguration: NotRequired[NumberFormatConfigurationTypeDef], # (2)
NumericalMeasureFieldTypeDef#
# NumericalMeasureFieldTypeDef definition
class NumericalMeasureFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
AggregationFunction: NotRequired[NumericalAggregationFunctionTypeDef], # (2)
FormatConfiguration: NotRequired[NumberFormatConfigurationTypeDef], # (3)
- See ColumnIdentifierTypeDef
- See NumericalAggregationFunctionTypeDef
- See NumberFormatConfigurationTypeDef
ReferenceLineLabelConfigurationTypeDef#
# ReferenceLineLabelConfigurationTypeDef definition
class ReferenceLineLabelConfigurationTypeDef(TypedDict):
ValueLabelConfiguration: NotRequired[ReferenceLineValueLabelConfigurationTypeDef], # (1)
CustomLabelConfiguration: NotRequired[ReferenceLineCustomLabelConfigurationTypeDef], # (2)
FontConfiguration: NotRequired[FontConfigurationTypeDef], # (3)
FontColor: NotRequired[str],
HorizontalPosition: NotRequired[ReferenceLineLabelHorizontalPositionType], # (4)
VerticalPosition: NotRequired[ReferenceLineLabelVerticalPositionType], # (5)
- See ReferenceLineValueLabelConfigurationTypeDef
- See ReferenceLineCustomLabelConfigurationTypeDef
- See FontConfigurationTypeDef
- See ReferenceLineLabelHorizontalPositionType
- See ReferenceLineLabelVerticalPositionType
CategoricalDimensionFieldTypeDef#
# CategoricalDimensionFieldTypeDef definition
class CategoricalDimensionFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
HierarchyId: NotRequired[str],
FormatConfiguration: NotRequired[StringFormatConfigurationTypeDef], # (2)
CategoricalMeasureFieldTypeDef#
# CategoricalMeasureFieldTypeDef definition
class CategoricalMeasureFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
AggregationFunction: NotRequired[CategoricalAggregationFunctionType], # (2)
FormatConfiguration: NotRequired[StringFormatConfigurationTypeDef], # (3)
- See ColumnIdentifierTypeDef
- See CategoricalAggregationFunctionType
- See StringFormatConfigurationTypeDef
FormatConfigurationTypeDef#
# FormatConfigurationTypeDef definition
class FormatConfigurationTypeDef(TypedDict):
StringFormatConfiguration: NotRequired[StringFormatConfigurationTypeDef], # (1)
NumberFormatConfiguration: NotRequired[NumberFormatConfigurationTypeDef], # (2)
DateTimeFormatConfiguration: NotRequired[DateTimeFormatConfigurationTypeDef], # (3)
- See StringFormatConfigurationTypeDef
- See NumberFormatConfigurationTypeDef
- See DateTimeFormatConfigurationTypeDef
FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
CategoryFilter: NotRequired[CategoryFilterTypeDef], # (1)
NumericRangeFilter: NotRequired[NumericRangeFilterTypeDef], # (2)
NumericEqualityFilter: NotRequired[NumericEqualityFilterTypeDef], # (3)
TimeEqualityFilter: NotRequired[TimeEqualityFilterTypeDef], # (4)
TimeRangeFilter: NotRequired[TimeRangeFilterTypeDef], # (5)
RelativeDatesFilter: NotRequired[RelativeDatesFilterTypeDef], # (6)
TopBottomFilter: NotRequired[TopBottomFilterTypeDef], # (7)
- See CategoryFilterTypeDef
- See NumericRangeFilterTypeDef
- See NumericEqualityFilterTypeDef
- See TimeEqualityFilterTypeDef
- See TimeRangeFilterTypeDef
- See RelativeDatesFilterTypeDef
- See TopBottomFilterTypeDef
BarChartSortConfigurationTypeDef#
# BarChartSortConfigurationTypeDef definition
class BarChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
ColorSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
ColorItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
SmallMultiplesSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
SmallMultiplesLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
BoxPlotSortConfigurationTypeDef#
# BoxPlotSortConfigurationTypeDef definition
class BoxPlotSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
PaginationConfiguration: NotRequired[PaginationConfigurationTypeDef], # (2)
ComboChartSortConfigurationTypeDef#
# ComboChartSortConfigurationTypeDef definition
class ComboChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
ColorSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
ColorItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
FilledMapSortConfigurationTypeDef#
# FilledMapSortConfigurationTypeDef definition
class FilledMapSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
FunnelChartSortConfigurationTypeDef#
# FunnelChartSortConfigurationTypeDef definition
class FunnelChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
HeatMapSortConfigurationTypeDef#
# HeatMapSortConfigurationTypeDef definition
class HeatMapSortConfigurationTypeDef(TypedDict):
HeatMapRowSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
HeatMapColumnSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
HeatMapRowItemsLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (3)
HeatMapColumnItemsLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (3)
- See FieldSortOptionsTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See ItemsLimitConfigurationTypeDef
KPISortConfigurationTypeDef#
# KPISortConfigurationTypeDef definition
class KPISortConfigurationTypeDef(TypedDict):
TrendGroupSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
LineChartSortConfigurationTypeDef#
# LineChartSortConfigurationTypeDef definition
class LineChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
ColorItemsLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
SmallMultiplesSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
SmallMultiplesLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
PieChartSortConfigurationTypeDef#
# PieChartSortConfigurationTypeDef definition
class PieChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
SmallMultiplesSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
SmallMultiplesLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
RadarChartSortConfigurationTypeDef#
# RadarChartSortConfigurationTypeDef definition
class RadarChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
ColorSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
ColorItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
- See FieldSortOptionsTypeDef
- See ItemsLimitConfigurationTypeDef
SankeyDiagramSortConfigurationTypeDef#
# SankeyDiagramSortConfigurationTypeDef definition
class SankeyDiagramSortConfigurationTypeDef(TypedDict):
WeightSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
SourceItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
DestinationItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
TableSortConfigurationTypeDef#
# TableSortConfigurationTypeDef definition
class TableSortConfigurationTypeDef(TypedDict):
RowSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
PaginationConfiguration: NotRequired[PaginationConfigurationTypeDef], # (2)
TreeMapSortConfigurationTypeDef#
# TreeMapSortConfigurationTypeDef definition
class TreeMapSortConfigurationTypeDef(TypedDict):
TreeMapSort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
TreeMapGroupItemsLimitConfiguration: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
WaterfallChartSortConfigurationTypeDef#
# WaterfallChartSortConfigurationTypeDef definition
class WaterfallChartSortConfigurationTypeDef(TypedDict):
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (1)
BreakdownItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (2)
WordCloudSortConfigurationTypeDef#
# WordCloudSortConfigurationTypeDef definition
class WordCloudSortConfigurationTypeDef(TypedDict):
CategoryItemsLimit: NotRequired[ItemsLimitConfigurationTypeDef], # (1)
CategorySort: NotRequired[Sequence[FieldSortOptionsTypeDef]], # (2)
PivotFieldSortOptionsTypeDef#
# PivotFieldSortOptionsTypeDef definition
class PivotFieldSortOptionsTypeDef(TypedDict):
FieldId: str,
SortBy: PivotTableSortByTypeDef, # (1)
FieldBasedTooltipTypeDef#
# FieldBasedTooltipTypeDef definition
class FieldBasedTooltipTypeDef(TypedDict):
AggregationVisibility: NotRequired[VisibilityType], # (1)
TooltipTitleType: NotRequired[TooltipTitleTypeType], # (2)
TooltipFields: NotRequired[Sequence[TooltipItemTypeDef]], # (3)
- See VisibilityType
- See TooltipTitleTypeType
- See TooltipItemTypeDef
TopicDetailsTypeDef#
# TopicDetailsTypeDef definition
class TopicDetailsTypeDef(TypedDict):
Name: NotRequired[str],
Description: NotRequired[str],
UserExperienceVersion: NotRequired[TopicUserExperienceVersionType], # (1)
DataSets: NotRequired[Sequence[DatasetMetadataTypeDef]], # (2)
DescribeAssetBundleImportJobResponseTypeDef#
# DescribeAssetBundleImportJobResponseTypeDef definition
class DescribeAssetBundleImportJobResponseTypeDef(TypedDict):
JobStatus: AssetBundleImportJobStatusType, # (1)
Errors: List[AssetBundleImportJobErrorTypeDef], # (2)
RollbackErrors: List[AssetBundleImportJobErrorTypeDef], # (2)
Arn: str,
CreatedTime: datetime,
AssetBundleImportJobId: str,
AwsAccountId: str,
AssetBundleImportSource: AssetBundleImportSourceDescriptionTypeDef, # (4)
OverrideParameters: AssetBundleImportJobOverrideParametersTypeDef, # (5)
FailureAction: AssetBundleImportFailureActionType, # (6)
RequestId: str,
Status: int,
OverridePermissions: AssetBundleImportJobOverridePermissionsTypeDef, # (7)
OverrideTags: AssetBundleImportJobOverrideTagsTypeDef, # (8)
OverrideValidationStrategy: AssetBundleImportJobOverrideValidationStrategyTypeDef, # (9)
ResponseMetadata: ResponseMetadataTypeDef, # (10)
- See AssetBundleImportJobStatusType
- See AssetBundleImportJobErrorTypeDef
- See AssetBundleImportJobErrorTypeDef
- See AssetBundleImportSourceDescriptionTypeDef
- See AssetBundleImportJobOverrideParametersTypeDef
- See AssetBundleImportFailureActionType
- See AssetBundleImportJobOverridePermissionsTypeDef
- See AssetBundleImportJobOverrideTagsTypeDef
- See AssetBundleImportJobOverrideValidationStrategyTypeDef
- See ResponseMetadataTypeDef
StartAssetBundleImportJobRequestRequestTypeDef#
# StartAssetBundleImportJobRequestRequestTypeDef definition
class StartAssetBundleImportJobRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AssetBundleImportJobId: str,
AssetBundleImportSource: AssetBundleImportSourceTypeDef, # (1)
OverrideParameters: NotRequired[AssetBundleImportJobOverrideParametersTypeDef], # (2)
FailureAction: NotRequired[AssetBundleImportFailureActionType], # (3)
OverridePermissions: NotRequired[AssetBundleImportJobOverridePermissionsTypeDef], # (4)
OverrideTags: NotRequired[AssetBundleImportJobOverrideTagsTypeDef], # (5)
OverrideValidationStrategy: NotRequired[AssetBundleImportJobOverrideValidationStrategyTypeDef], # (6)
- See AssetBundleImportSourceTypeDef
- See AssetBundleImportJobOverrideParametersTypeDef
- See AssetBundleImportFailureActionType
- See AssetBundleImportJobOverridePermissionsTypeDef
- See AssetBundleImportJobOverrideTagsTypeDef
- See AssetBundleImportJobOverrideValidationStrategyTypeDef
CreateDataSourceRequestRequestTypeDef#
# CreateDataSourceRequestRequestTypeDef definition
class CreateDataSourceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
Name: str,
Type: DataSourceTypeType, # (1)
DataSourceParameters: NotRequired[DataSourceParametersTypeDef], # (2)
Credentials: NotRequired[DataSourceCredentialsTypeDef], # (3)
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (4)
VpcConnectionProperties: NotRequired[VpcConnectionPropertiesTypeDef], # (5)
SslProperties: NotRequired[SslPropertiesTypeDef], # (6)
Tags: NotRequired[Sequence[TagTypeDef]], # (7)
FolderArns: NotRequired[Sequence[str]],
- See DataSourceTypeType
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See ResourcePermissionTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See TagTypeDef
UpdateDataSourceRequestRequestTypeDef#
# UpdateDataSourceRequestRequestTypeDef definition
class UpdateDataSourceRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DataSourceId: str,
Name: str,
DataSourceParameters: NotRequired[DataSourceParametersTypeDef], # (1)
Credentials: NotRequired[DataSourceCredentialsTypeDef], # (2)
VpcConnectionProperties: NotRequired[VpcConnectionPropertiesTypeDef], # (3)
SslProperties: NotRequired[SslPropertiesTypeDef], # (4)
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
SnapshotJobResultTypeDef#
# SnapshotJobResultTypeDef definition
class SnapshotJobResultTypeDef(TypedDict):
AnonymousUsers: NotRequired[List[AnonymousUserSnapshotJobResultTypeDef]], # (1)
DefaultNewSheetConfigurationTypeDef#
# DefaultNewSheetConfigurationTypeDef definition
class DefaultNewSheetConfigurationTypeDef(TypedDict):
InteractiveLayoutConfiguration: NotRequired[DefaultInteractiveLayoutConfigurationTypeDef], # (1)
PaginatedLayoutConfiguration: NotRequired[DefaultPaginatedLayoutConfigurationTypeDef], # (2)
SheetContentType: NotRequired[SheetContentTypeType], # (3)
- See DefaultInteractiveLayoutConfigurationTypeDef
- See DefaultPaginatedLayoutConfigurationTypeDef
- See SheetContentTypeType
BodySectionContentTypeDef#
# BodySectionContentTypeDef definition
class BodySectionContentTypeDef(TypedDict):
Layout: NotRequired[SectionLayoutConfigurationTypeDef], # (1)
HeaderFooterSectionConfigurationTypeDef#
# HeaderFooterSectionConfigurationTypeDef definition
class HeaderFooterSectionConfigurationTypeDef(TypedDict):
SectionId: str,
Layout: SectionLayoutConfigurationTypeDef, # (1)
Style: NotRequired[SectionStyleTypeDef], # (2)
VisualCustomActionOperationTypeDef#
# VisualCustomActionOperationTypeDef definition
class VisualCustomActionOperationTypeDef(TypedDict):
FilterOperation: NotRequired[CustomActionFilterOperationTypeDef], # (1)
NavigationOperation: NotRequired[CustomActionNavigationOperationTypeDef], # (2)
URLOperation: NotRequired[CustomActionURLOperationTypeDef], # (3)
SetParametersOperation: NotRequired[CustomActionSetParametersOperationTypeDef], # (4)
- See CustomActionFilterOperationTypeDef
- See CustomActionNavigationOperationTypeDef
- See CustomActionURLOperationTypeDef
- See CustomActionSetParametersOperationTypeDef
DescribeDataSetResponseTypeDef#
# DescribeDataSetResponseTypeDef definition
class DescribeDataSetResponseTypeDef(TypedDict):
DataSet: DataSetTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TableFieldOptionTypeDef#
# TableFieldOptionTypeDef definition
class TableFieldOptionTypeDef(TypedDict):
FieldId: str,
Width: NotRequired[str],
CustomLabel: NotRequired[str],
Visibility: NotRequired[VisibilityType], # (1)
URLStyling: NotRequired[TableFieldURLConfigurationTypeDef], # (2)
GaugeChartConditionalFormattingTypeDef#
# GaugeChartConditionalFormattingTypeDef definition
class GaugeChartConditionalFormattingTypeDef(TypedDict):
ConditionalFormattingOptions: NotRequired[Sequence[GaugeChartConditionalFormattingOptionTypeDef]], # (1)
KPIConditionalFormattingTypeDef#
# KPIConditionalFormattingTypeDef definition
class KPIConditionalFormattingTypeDef(TypedDict):
ConditionalFormattingOptions: NotRequired[Sequence[KPIConditionalFormattingOptionTypeDef]], # (1)
FilledMapConditionalFormattingOptionTypeDef#
# FilledMapConditionalFormattingOptionTypeDef definition
class FilledMapConditionalFormattingOptionTypeDef(TypedDict):
Shape: FilledMapShapeConditionalFormattingTypeDef, # (1)
PivotTableConditionalFormattingOptionTypeDef#
# PivotTableConditionalFormattingOptionTypeDef definition
class PivotTableConditionalFormattingOptionTypeDef(TypedDict):
Cell: NotRequired[PivotTableCellConditionalFormattingTypeDef], # (1)
TableConditionalFormattingOptionTypeDef#
# TableConditionalFormattingOptionTypeDef definition
class TableConditionalFormattingOptionTypeDef(TypedDict):
Cell: NotRequired[TableCellConditionalFormattingTypeDef], # (1)
Row: NotRequired[TableRowConditionalFormattingTypeDef], # (2)
DescribeThemeResponseTypeDef#
# DescribeThemeResponseTypeDef definition
class DescribeThemeResponseTypeDef(TypedDict):
Theme: ThemeTypeDef, # (1)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ThemeTypeDef
- See ResponseMetadataTypeDef
ReferenceLineTypeDef#
# ReferenceLineTypeDef definition
class ReferenceLineTypeDef(TypedDict):
DataConfiguration: ReferenceLineDataConfigurationTypeDef, # (2)
Status: NotRequired[WidgetStatusType], # (1)
StyleConfiguration: NotRequired[ReferenceLineStyleConfigurationTypeDef], # (3)
LabelConfiguration: NotRequired[ReferenceLineLabelConfigurationTypeDef], # (4)
- See WidgetStatusType
- See ReferenceLineDataConfigurationTypeDef
- See ReferenceLineStyleConfigurationTypeDef
- See ReferenceLineLabelConfigurationTypeDef
DimensionFieldTypeDef#
# DimensionFieldTypeDef definition
class DimensionFieldTypeDef(TypedDict):
NumericalDimensionField: NotRequired[NumericalDimensionFieldTypeDef], # (1)
CategoricalDimensionField: NotRequired[CategoricalDimensionFieldTypeDef], # (2)
DateDimensionField: NotRequired[DateDimensionFieldTypeDef], # (3)
- See NumericalDimensionFieldTypeDef
- See CategoricalDimensionFieldTypeDef
- See DateDimensionFieldTypeDef
MeasureFieldTypeDef#
# MeasureFieldTypeDef definition
class MeasureFieldTypeDef(TypedDict):
NumericalMeasureField: NotRequired[NumericalMeasureFieldTypeDef], # (1)
CategoricalMeasureField: NotRequired[CategoricalMeasureFieldTypeDef], # (2)
DateMeasureField: NotRequired[DateMeasureFieldTypeDef], # (3)
CalculatedMeasureField: NotRequired[CalculatedMeasureFieldTypeDef], # (4)
- See NumericalMeasureFieldTypeDef
- See CategoricalMeasureFieldTypeDef
- See DateMeasureFieldTypeDef
- See CalculatedMeasureFieldTypeDef
ColumnConfigurationTypeDef#
# ColumnConfigurationTypeDef definition
class ColumnConfigurationTypeDef(TypedDict):
Column: ColumnIdentifierTypeDef, # (1)
FormatConfiguration: NotRequired[FormatConfigurationTypeDef], # (2)
Role: NotRequired[ColumnRoleType], # (3)
ColorsConfiguration: NotRequired[ColorsConfigurationTypeDef], # (4)
- See ColumnIdentifierTypeDef
- See FormatConfigurationTypeDef
- See ColumnRoleType
- See ColorsConfigurationTypeDef
UnaggregatedFieldTypeDef#
# UnaggregatedFieldTypeDef definition
class UnaggregatedFieldTypeDef(TypedDict):
FieldId: str,
Column: ColumnIdentifierTypeDef, # (1)
FormatConfiguration: NotRequired[FormatConfigurationTypeDef], # (2)
FilterGroupTypeDef#
# FilterGroupTypeDef definition
class FilterGroupTypeDef(TypedDict):
FilterGroupId: str,
Filters: Sequence[FilterTypeDef], # (1)
ScopeConfiguration: FilterScopeConfigurationTypeDef, # (2)
CrossDataset: CrossDatasetTypesType, # (4)
Status: NotRequired[WidgetStatusType], # (3)
- See FilterTypeDef
- See FilterScopeConfigurationTypeDef
- See WidgetStatusType
- See CrossDatasetTypesType
PivotTableSortConfigurationTypeDef#
# PivotTableSortConfigurationTypeDef definition
class PivotTableSortConfigurationTypeDef(TypedDict):
FieldSortOptions: NotRequired[Sequence[PivotFieldSortOptionsTypeDef]], # (1)
TooltipOptionsTypeDef#
# TooltipOptionsTypeDef definition
class TooltipOptionsTypeDef(TypedDict):
TooltipVisibility: NotRequired[VisibilityType], # (1)
SelectedTooltipType: NotRequired[SelectedTooltipTypeType], # (2)
FieldBasedTooltip: NotRequired[FieldBasedTooltipTypeDef], # (3)
CreateTopicRequestRequestTypeDef#
# CreateTopicRequestRequestTypeDef definition
class CreateTopicRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See TopicDetailsTypeDef
- See TagTypeDef
DescribeTopicResponseTypeDef#
# DescribeTopicResponseTypeDef definition
class DescribeTopicResponseTypeDef(TypedDict):
Arn: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateTopicRequestRequestTypeDef#
# UpdateTopicRequestRequestTypeDef definition
class UpdateTopicRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
DescribeDashboardSnapshotJobResultResponseTypeDef#
# DescribeDashboardSnapshotJobResultResponseTypeDef definition
class DescribeDashboardSnapshotJobResultResponseTypeDef(TypedDict):
Arn: str,
JobStatus: SnapshotJobStatusType, # (1)
CreatedTime: datetime,
LastUpdatedTime: datetime,
Result: SnapshotJobResultTypeDef, # (2)
ErrorInfo: SnapshotJobErrorInfoTypeDef, # (3)
RequestId: str,
Status: int,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See SnapshotJobStatusType
- See SnapshotJobResultTypeDef
- See SnapshotJobErrorInfoTypeDef
- See ResponseMetadataTypeDef
AnalysisDefaultsTypeDef#
# AnalysisDefaultsTypeDef definition
class AnalysisDefaultsTypeDef(TypedDict):
DefaultNewSheetConfiguration: DefaultNewSheetConfigurationTypeDef, # (1)
BodySectionConfigurationTypeDef#
# BodySectionConfigurationTypeDef definition
class BodySectionConfigurationTypeDef(TypedDict):
SectionId: str,
Content: BodySectionContentTypeDef, # (1)
Style: NotRequired[SectionStyleTypeDef], # (2)
PageBreakConfiguration: NotRequired[SectionPageBreakConfigurationTypeDef], # (3)
VisualCustomActionTypeDef#
# VisualCustomActionTypeDef definition
class VisualCustomActionTypeDef(TypedDict):
CustomActionId: str,
Name: str,
Trigger: VisualCustomActionTriggerType, # (2)
ActionOperations: Sequence[VisualCustomActionOperationTypeDef], # (3)
Status: NotRequired[WidgetStatusType], # (1)
TableFieldOptionsTypeDef#
# TableFieldOptionsTypeDef definition
class TableFieldOptionsTypeDef(TypedDict):
SelectedFieldOptions: NotRequired[Sequence[TableFieldOptionTypeDef]], # (1)
Order: NotRequired[Sequence[str]],
PinnedFieldOptions: NotRequired[TablePinnedFieldOptionsTypeDef], # (2)
FilledMapConditionalFormattingTypeDef#
# FilledMapConditionalFormattingTypeDef definition
class FilledMapConditionalFormattingTypeDef(TypedDict):
ConditionalFormattingOptions: Sequence[FilledMapConditionalFormattingOptionTypeDef], # (1)
PivotTableConditionalFormattingTypeDef#
# PivotTableConditionalFormattingTypeDef definition
class PivotTableConditionalFormattingTypeDef(TypedDict):
ConditionalFormattingOptions: NotRequired[Sequence[PivotTableConditionalFormattingOptionTypeDef]], # (1)
TableConditionalFormattingTypeDef#
# TableConditionalFormattingTypeDef definition
class TableConditionalFormattingTypeDef(TypedDict):
ConditionalFormattingOptions: NotRequired[Sequence[TableConditionalFormattingOptionTypeDef]], # (1)
UniqueValuesComputationTypeDef#
# UniqueValuesComputationTypeDef definition
class UniqueValuesComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Category: NotRequired[DimensionFieldTypeDef], # (1)
BarChartAggregatedFieldWellsTypeDef#
# BarChartAggregatedFieldWellsTypeDef definition
class BarChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Colors: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
SmallMultiples: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
- See DimensionFieldTypeDef
- See MeasureFieldTypeDef
- See DimensionFieldTypeDef
- See DimensionFieldTypeDef
BoxPlotAggregatedFieldWellsTypeDef#
# BoxPlotAggregatedFieldWellsTypeDef definition
class BoxPlotAggregatedFieldWellsTypeDef(TypedDict):
GroupBy: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
ComboChartAggregatedFieldWellsTypeDef#
# ComboChartAggregatedFieldWellsTypeDef definition
class ComboChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
BarValues: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Colors: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
LineValues: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
FilledMapAggregatedFieldWellsTypeDef#
# FilledMapAggregatedFieldWellsTypeDef definition
class FilledMapAggregatedFieldWellsTypeDef(TypedDict):
Geospatial: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
ForecastComputationTypeDef#
# ForecastComputationTypeDef definition
class ForecastComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
PeriodsForward: NotRequired[int],
PeriodsBackward: NotRequired[int],
UpperBoundary: NotRequired[float],
LowerBoundary: NotRequired[float],
PredictionInterval: NotRequired[int],
Seasonality: NotRequired[ForecastComputationSeasonalityType], # (3)
CustomSeasonalityValue: NotRequired[int],
FunnelChartAggregatedFieldWellsTypeDef#
# FunnelChartAggregatedFieldWellsTypeDef definition
class FunnelChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
GaugeChartFieldWellsTypeDef#
# GaugeChartFieldWellsTypeDef definition
class GaugeChartFieldWellsTypeDef(TypedDict):
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
TargetValues: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
GeospatialMapAggregatedFieldWellsTypeDef#
# GeospatialMapAggregatedFieldWellsTypeDef definition
class GeospatialMapAggregatedFieldWellsTypeDef(TypedDict):
Geospatial: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Colors: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
GrowthRateComputationTypeDef#
# GrowthRateComputationTypeDef definition
class GrowthRateComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
PeriodSize: NotRequired[int],
HeatMapAggregatedFieldWellsTypeDef#
# HeatMapAggregatedFieldWellsTypeDef definition
class HeatMapAggregatedFieldWellsTypeDef(TypedDict):
Rows: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Columns: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (3)
HistogramAggregatedFieldWellsTypeDef#
# HistogramAggregatedFieldWellsTypeDef definition
class HistogramAggregatedFieldWellsTypeDef(TypedDict):
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
KPIFieldWellsTypeDef#
# KPIFieldWellsTypeDef definition
class KPIFieldWellsTypeDef(TypedDict):
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
TargetValues: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
TrendGroups: NotRequired[Sequence[DimensionFieldTypeDef]], # (3)
LineChartAggregatedFieldWellsTypeDef#
# LineChartAggregatedFieldWellsTypeDef definition
class LineChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Colors: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
SmallMultiples: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
- See DimensionFieldTypeDef
- See MeasureFieldTypeDef
- See DimensionFieldTypeDef
- See DimensionFieldTypeDef
MaximumMinimumComputationTypeDef#
# MaximumMinimumComputationTypeDef definition
class MaximumMinimumComputationTypeDef(TypedDict):
ComputationId: str,
Type: MaximumMinimumComputationTypeType, # (3)
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
MetricComparisonComputationTypeDef#
# MetricComparisonComputationTypeDef definition
class MetricComparisonComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
FromValue: NotRequired[MeasureFieldTypeDef], # (2)
TargetValue: NotRequired[MeasureFieldTypeDef], # (2)
PeriodOverPeriodComputationTypeDef#
# PeriodOverPeriodComputationTypeDef definition
class PeriodOverPeriodComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
PeriodToDateComputationTypeDef#
# PeriodToDateComputationTypeDef definition
class PeriodToDateComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
PeriodTimeGranularity: NotRequired[TimeGranularityType], # (3)
PieChartAggregatedFieldWellsTypeDef#
# PieChartAggregatedFieldWellsTypeDef definition
class PieChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
SmallMultiples: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
PivotTableAggregatedFieldWellsTypeDef#
# PivotTableAggregatedFieldWellsTypeDef definition
class PivotTableAggregatedFieldWellsTypeDef(TypedDict):
Rows: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Columns: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (3)
RadarChartAggregatedFieldWellsTypeDef#
# RadarChartAggregatedFieldWellsTypeDef definition
class RadarChartAggregatedFieldWellsTypeDef(TypedDict):
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Color: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (3)
SankeyDiagramAggregatedFieldWellsTypeDef#
# SankeyDiagramAggregatedFieldWellsTypeDef definition
class SankeyDiagramAggregatedFieldWellsTypeDef(TypedDict):
Source: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Destination: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Weight: NotRequired[Sequence[MeasureFieldTypeDef]], # (3)
ScatterPlotCategoricallyAggregatedFieldWellsTypeDef#
# ScatterPlotCategoricallyAggregatedFieldWellsTypeDef definition
class ScatterPlotCategoricallyAggregatedFieldWellsTypeDef(TypedDict):
XAxis: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
YAxis: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (3)
Size: NotRequired[Sequence[MeasureFieldTypeDef]], # (1)
Label: NotRequired[Sequence[DimensionFieldTypeDef]], # (3)
- See MeasureFieldTypeDef
- See MeasureFieldTypeDef
- See DimensionFieldTypeDef
- See MeasureFieldTypeDef
- See DimensionFieldTypeDef
ScatterPlotUnaggregatedFieldWellsTypeDef#
# ScatterPlotUnaggregatedFieldWellsTypeDef definition
class ScatterPlotUnaggregatedFieldWellsTypeDef(TypedDict):
XAxis: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
YAxis: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Size: NotRequired[Sequence[MeasureFieldTypeDef]], # (3)
Category: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Label: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
- See DimensionFieldTypeDef
- See DimensionFieldTypeDef
- See MeasureFieldTypeDef
- See DimensionFieldTypeDef
- See DimensionFieldTypeDef
TableAggregatedFieldWellsTypeDef#
# TableAggregatedFieldWellsTypeDef definition
class TableAggregatedFieldWellsTypeDef(TypedDict):
GroupBy: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
TopBottomMoversComputationTypeDef#
# TopBottomMoversComputationTypeDef definition
class TopBottomMoversComputationTypeDef(TypedDict):
ComputationId: str,
Type: TopBottomComputationTypeType, # (5)
Name: NotRequired[str],
Time: NotRequired[DimensionFieldTypeDef], # (1)
Category: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (3)
MoverSize: NotRequired[int],
SortOrder: NotRequired[TopBottomSortOrderType], # (4)
- See DimensionFieldTypeDef
- See DimensionFieldTypeDef
- See MeasureFieldTypeDef
- See TopBottomSortOrderType
- See TopBottomComputationTypeType
TopBottomRankedComputationTypeDef#
# TopBottomRankedComputationTypeDef definition
class TopBottomRankedComputationTypeDef(TypedDict):
ComputationId: str,
Type: TopBottomComputationTypeType, # (3)
Name: NotRequired[str],
Category: NotRequired[DimensionFieldTypeDef], # (1)
Value: NotRequired[MeasureFieldTypeDef], # (2)
ResultSize: NotRequired[int],
TotalAggregationComputationTypeDef#
# TotalAggregationComputationTypeDef definition
class TotalAggregationComputationTypeDef(TypedDict):
ComputationId: str,
Name: NotRequired[str],
Value: NotRequired[MeasureFieldTypeDef], # (1)
TreeMapAggregatedFieldWellsTypeDef#
# TreeMapAggregatedFieldWellsTypeDef definition
class TreeMapAggregatedFieldWellsTypeDef(TypedDict):
Groups: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Sizes: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Colors: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
WaterfallChartAggregatedFieldWellsTypeDef#
# WaterfallChartAggregatedFieldWellsTypeDef definition
class WaterfallChartAggregatedFieldWellsTypeDef(TypedDict):
Categories: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Values: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
Breakdowns: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
WordCloudAggregatedFieldWellsTypeDef#
# WordCloudAggregatedFieldWellsTypeDef definition
class WordCloudAggregatedFieldWellsTypeDef(TypedDict):
GroupBy: NotRequired[Sequence[DimensionFieldTypeDef]], # (1)
Size: NotRequired[Sequence[MeasureFieldTypeDef]], # (2)
TableUnaggregatedFieldWellsTypeDef#
# TableUnaggregatedFieldWellsTypeDef definition
class TableUnaggregatedFieldWellsTypeDef(TypedDict):
Values: NotRequired[Sequence[UnaggregatedFieldTypeDef]], # (1)
SectionBasedLayoutConfigurationTypeDef#
# SectionBasedLayoutConfigurationTypeDef definition
class SectionBasedLayoutConfigurationTypeDef(TypedDict):
HeaderSections: Sequence[HeaderFooterSectionConfigurationTypeDef], # (1)
BodySections: Sequence[BodySectionConfigurationTypeDef], # (2)
FooterSections: Sequence[HeaderFooterSectionConfigurationTypeDef], # (1)
CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptionsTypeDef, # (4)
- See HeaderFooterSectionConfigurationTypeDef
- See BodySectionConfigurationTypeDef
- See HeaderFooterSectionConfigurationTypeDef
- See SectionBasedLayoutCanvasSizeOptionsTypeDef
CustomContentVisualTypeDef#
# CustomContentVisualTypeDef definition
class CustomContentVisualTypeDef(TypedDict):
VisualId: str,
DataSetIdentifier: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[CustomContentConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See CustomContentConfigurationTypeDef
- See VisualCustomActionTypeDef
EmptyVisualTypeDef#
# EmptyVisualTypeDef definition
class EmptyVisualTypeDef(TypedDict):
VisualId: str,
DataSetIdentifier: str,
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (1)
BarChartFieldWellsTypeDef#
# BarChartFieldWellsTypeDef definition
class BarChartFieldWellsTypeDef(TypedDict):
BarChartAggregatedFieldWells: NotRequired[BarChartAggregatedFieldWellsTypeDef], # (1)
BoxPlotFieldWellsTypeDef#
# BoxPlotFieldWellsTypeDef definition
class BoxPlotFieldWellsTypeDef(TypedDict):
BoxPlotAggregatedFieldWells: NotRequired[BoxPlotAggregatedFieldWellsTypeDef], # (1)
ComboChartFieldWellsTypeDef#
# ComboChartFieldWellsTypeDef definition
class ComboChartFieldWellsTypeDef(TypedDict):
ComboChartAggregatedFieldWells: NotRequired[ComboChartAggregatedFieldWellsTypeDef], # (1)
FilledMapFieldWellsTypeDef#
# FilledMapFieldWellsTypeDef definition
class FilledMapFieldWellsTypeDef(TypedDict):
FilledMapAggregatedFieldWells: NotRequired[FilledMapAggregatedFieldWellsTypeDef], # (1)
FunnelChartFieldWellsTypeDef#
# FunnelChartFieldWellsTypeDef definition
class FunnelChartFieldWellsTypeDef(TypedDict):
FunnelChartAggregatedFieldWells: NotRequired[FunnelChartAggregatedFieldWellsTypeDef], # (1)
GaugeChartConfigurationTypeDef#
# GaugeChartConfigurationTypeDef definition
class GaugeChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[GaugeChartFieldWellsTypeDef], # (1)
GaugeChartOptions: NotRequired[GaugeChartOptionsTypeDef], # (2)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (3)
TooltipOptions: NotRequired[TooltipOptionsTypeDef], # (4)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (5)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (6)
- See GaugeChartFieldWellsTypeDef
- See GaugeChartOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
GeospatialMapFieldWellsTypeDef#
# GeospatialMapFieldWellsTypeDef definition
class GeospatialMapFieldWellsTypeDef(TypedDict):
GeospatialMapAggregatedFieldWells: NotRequired[GeospatialMapAggregatedFieldWellsTypeDef], # (1)
HeatMapFieldWellsTypeDef#
# HeatMapFieldWellsTypeDef definition
class HeatMapFieldWellsTypeDef(TypedDict):
HeatMapAggregatedFieldWells: NotRequired[HeatMapAggregatedFieldWellsTypeDef], # (1)
HistogramFieldWellsTypeDef#
# HistogramFieldWellsTypeDef definition
class HistogramFieldWellsTypeDef(TypedDict):
HistogramAggregatedFieldWells: NotRequired[HistogramAggregatedFieldWellsTypeDef], # (1)
KPIConfigurationTypeDef#
# KPIConfigurationTypeDef definition
class KPIConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[KPIFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[KPISortConfigurationTypeDef], # (2)
KPIOptions: NotRequired[KPIOptionsTypeDef], # (3)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (4)
- See KPIFieldWellsTypeDef
- See KPISortConfigurationTypeDef
- See KPIOptionsTypeDef
- See VisualInteractionOptionsTypeDef
LineChartFieldWellsTypeDef#
# LineChartFieldWellsTypeDef definition
class LineChartFieldWellsTypeDef(TypedDict):
LineChartAggregatedFieldWells: NotRequired[LineChartAggregatedFieldWellsTypeDef], # (1)
PieChartFieldWellsTypeDef#
# PieChartFieldWellsTypeDef definition
class PieChartFieldWellsTypeDef(TypedDict):
PieChartAggregatedFieldWells: NotRequired[PieChartAggregatedFieldWellsTypeDef], # (1)
PivotTableFieldWellsTypeDef#
# PivotTableFieldWellsTypeDef definition
class PivotTableFieldWellsTypeDef(TypedDict):
PivotTableAggregatedFieldWells: NotRequired[PivotTableAggregatedFieldWellsTypeDef], # (1)
RadarChartFieldWellsTypeDef#
# RadarChartFieldWellsTypeDef definition
class RadarChartFieldWellsTypeDef(TypedDict):
RadarChartAggregatedFieldWells: NotRequired[RadarChartAggregatedFieldWellsTypeDef], # (1)
SankeyDiagramFieldWellsTypeDef#
# SankeyDiagramFieldWellsTypeDef definition
class SankeyDiagramFieldWellsTypeDef(TypedDict):
SankeyDiagramAggregatedFieldWells: NotRequired[SankeyDiagramAggregatedFieldWellsTypeDef], # (1)
ScatterPlotFieldWellsTypeDef#
# ScatterPlotFieldWellsTypeDef definition
class ScatterPlotFieldWellsTypeDef(TypedDict):
ScatterPlotCategoricallyAggregatedFieldWells: NotRequired[ScatterPlotCategoricallyAggregatedFieldWellsTypeDef], # (1)
ScatterPlotUnaggregatedFieldWells: NotRequired[ScatterPlotUnaggregatedFieldWellsTypeDef], # (2)
- See ScatterPlotCategoricallyAggregatedFieldWellsTypeDef
- See ScatterPlotUnaggregatedFieldWellsTypeDef
ComputationTypeDef#
# ComputationTypeDef definition
class ComputationTypeDef(TypedDict):
TopBottomRanked: NotRequired[TopBottomRankedComputationTypeDef], # (1)
TopBottomMovers: NotRequired[TopBottomMoversComputationTypeDef], # (2)
TotalAggregation: NotRequired[TotalAggregationComputationTypeDef], # (3)
MaximumMinimum: NotRequired[MaximumMinimumComputationTypeDef], # (4)
MetricComparison: NotRequired[MetricComparisonComputationTypeDef], # (5)
PeriodOverPeriod: NotRequired[PeriodOverPeriodComputationTypeDef], # (6)
PeriodToDate: NotRequired[PeriodToDateComputationTypeDef], # (7)
GrowthRate: NotRequired[GrowthRateComputationTypeDef], # (8)
UniqueValues: NotRequired[UniqueValuesComputationTypeDef], # (9)
Forecast: NotRequired[ForecastComputationTypeDef], # (10)
- See TopBottomRankedComputationTypeDef
- See TopBottomMoversComputationTypeDef
- See TotalAggregationComputationTypeDef
- See MaximumMinimumComputationTypeDef
- See MetricComparisonComputationTypeDef
- See PeriodOverPeriodComputationTypeDef
- See PeriodToDateComputationTypeDef
- See GrowthRateComputationTypeDef
- See UniqueValuesComputationTypeDef
- See ForecastComputationTypeDef
TreeMapFieldWellsTypeDef#
# TreeMapFieldWellsTypeDef definition
class TreeMapFieldWellsTypeDef(TypedDict):
TreeMapAggregatedFieldWells: NotRequired[TreeMapAggregatedFieldWellsTypeDef], # (1)
WaterfallChartFieldWellsTypeDef#
# WaterfallChartFieldWellsTypeDef definition
class WaterfallChartFieldWellsTypeDef(TypedDict):
WaterfallChartAggregatedFieldWells: NotRequired[WaterfallChartAggregatedFieldWellsTypeDef], # (1)
WordCloudFieldWellsTypeDef#
# WordCloudFieldWellsTypeDef definition
class WordCloudFieldWellsTypeDef(TypedDict):
WordCloudAggregatedFieldWells: NotRequired[WordCloudAggregatedFieldWellsTypeDef], # (1)
TableFieldWellsTypeDef#
# TableFieldWellsTypeDef definition
class TableFieldWellsTypeDef(TypedDict):
TableAggregatedFieldWells: NotRequired[TableAggregatedFieldWellsTypeDef], # (1)
TableUnaggregatedFieldWells: NotRequired[TableUnaggregatedFieldWellsTypeDef], # (2)
LayoutConfigurationTypeDef#
# LayoutConfigurationTypeDef definition
class LayoutConfigurationTypeDef(TypedDict):
GridLayout: NotRequired[GridLayoutConfigurationTypeDef], # (1)
FreeFormLayout: NotRequired[FreeFormLayoutConfigurationTypeDef], # (2)
SectionBasedLayout: NotRequired[SectionBasedLayoutConfigurationTypeDef], # (3)
- See GridLayoutConfigurationTypeDef
- See FreeFormLayoutConfigurationTypeDef
- See SectionBasedLayoutConfigurationTypeDef
BarChartConfigurationTypeDef#
# BarChartConfigurationTypeDef definition
class BarChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[BarChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[BarChartSortConfigurationTypeDef], # (2)
Orientation: NotRequired[BarChartOrientationType], # (3)
BarsArrangement: NotRequired[BarsArrangementType], # (4)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (5)
SmallMultiplesOptions: NotRequired[SmallMultiplesOptionsTypeDef], # (6)
CategoryAxis: NotRequired[AxisDisplayOptionsTypeDef], # (7)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (8)
ValueAxis: NotRequired[AxisDisplayOptionsTypeDef], # (7)
ValueLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (8)
ColorLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (8)
Legend: NotRequired[LegendOptionsTypeDef], # (12)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (13)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (14)
ReferenceLines: NotRequired[Sequence[ReferenceLineTypeDef]], # (15)
ContributionAnalysisDefaults: NotRequired[Sequence[ContributionAnalysisDefaultTypeDef]], # (16)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (17)
- See BarChartFieldWellsTypeDef
- See BarChartSortConfigurationTypeDef
- See BarChartOrientationType
- See BarsArrangementType
- See VisualPaletteTypeDef
- See SmallMultiplesOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See ReferenceLineTypeDef
- See ContributionAnalysisDefaultTypeDef
- See VisualInteractionOptionsTypeDef
BoxPlotChartConfigurationTypeDef#
# BoxPlotChartConfigurationTypeDef definition
class BoxPlotChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[BoxPlotFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[BoxPlotSortConfigurationTypeDef], # (2)
BoxPlotOptions: NotRequired[BoxPlotOptionsTypeDef], # (3)
CategoryAxis: NotRequired[AxisDisplayOptionsTypeDef], # (4)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
PrimaryYAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (4)
PrimaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
Legend: NotRequired[LegendOptionsTypeDef], # (8)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (9)
ReferenceLines: NotRequired[Sequence[ReferenceLineTypeDef]], # (10)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (11)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (12)
- See BoxPlotFieldWellsTypeDef
- See BoxPlotSortConfigurationTypeDef
- See BoxPlotOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LegendOptionsTypeDef
- See TooltipOptionsTypeDef
- See ReferenceLineTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
ComboChartConfigurationTypeDef#
# ComboChartConfigurationTypeDef definition
class ComboChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[ComboChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[ComboChartSortConfigurationTypeDef], # (2)
BarsArrangement: NotRequired[BarsArrangementType], # (3)
CategoryAxis: NotRequired[AxisDisplayOptionsTypeDef], # (4)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
PrimaryYAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (4)
PrimaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
SecondaryYAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (4)
SecondaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
SingleAxisOptions: NotRequired[SingleAxisOptionsTypeDef], # (10)
ColorLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
Legend: NotRequired[LegendOptionsTypeDef], # (12)
BarDataLabels: NotRequired[DataLabelOptionsTypeDef], # (13)
LineDataLabels: NotRequired[DataLabelOptionsTypeDef], # (13)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (15)
ReferenceLines: NotRequired[Sequence[ReferenceLineTypeDef]], # (16)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (17)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (18)
- See ComboChartFieldWellsTypeDef
- See ComboChartSortConfigurationTypeDef
- See BarsArrangementType
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See SingleAxisOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See ReferenceLineTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
FilledMapConfigurationTypeDef#
# FilledMapConfigurationTypeDef definition
class FilledMapConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[FilledMapFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[FilledMapSortConfigurationTypeDef], # (2)
Legend: NotRequired[LegendOptionsTypeDef], # (3)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (4)
WindowOptions: NotRequired[GeospatialWindowOptionsTypeDef], # (5)
MapStyleOptions: NotRequired[GeospatialMapStyleOptionsTypeDef], # (6)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (7)
- See FilledMapFieldWellsTypeDef
- See FilledMapSortConfigurationTypeDef
- See LegendOptionsTypeDef
- See TooltipOptionsTypeDef
- See GeospatialWindowOptionsTypeDef
- See GeospatialMapStyleOptionsTypeDef
- See VisualInteractionOptionsTypeDef
FunnelChartConfigurationTypeDef#
# FunnelChartConfigurationTypeDef definition
class FunnelChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[FunnelChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[FunnelChartSortConfigurationTypeDef], # (2)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
ValueLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (5)
DataLabelOptions: NotRequired[FunnelChartDataLabelOptionsTypeDef], # (6)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (7)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (8)
- See FunnelChartFieldWellsTypeDef
- See FunnelChartSortConfigurationTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See FunnelChartDataLabelOptionsTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
GaugeChartVisualTypeDef#
# GaugeChartVisualTypeDef definition
class GaugeChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[GaugeChartConfigurationTypeDef], # (3)
ConditionalFormatting: NotRequired[GaugeChartConditionalFormattingTypeDef], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See GaugeChartConfigurationTypeDef
- See GaugeChartConditionalFormattingTypeDef
- See VisualCustomActionTypeDef
GeospatialMapConfigurationTypeDef#
# GeospatialMapConfigurationTypeDef definition
class GeospatialMapConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[GeospatialMapFieldWellsTypeDef], # (1)
Legend: NotRequired[LegendOptionsTypeDef], # (2)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (3)
WindowOptions: NotRequired[GeospatialWindowOptionsTypeDef], # (4)
MapStyleOptions: NotRequired[GeospatialMapStyleOptionsTypeDef], # (5)
PointStyleOptions: NotRequired[GeospatialPointStyleOptionsTypeDef], # (6)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (7)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (8)
- See GeospatialMapFieldWellsTypeDef
- See LegendOptionsTypeDef
- See TooltipOptionsTypeDef
- See GeospatialWindowOptionsTypeDef
- See GeospatialMapStyleOptionsTypeDef
- See GeospatialPointStyleOptionsTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
HeatMapConfigurationTypeDef#
# HeatMapConfigurationTypeDef definition
class HeatMapConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[HeatMapFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[HeatMapSortConfigurationTypeDef], # (2)
RowLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
ColumnLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
ColorScale: NotRequired[ColorScaleTypeDef], # (5)
Legend: NotRequired[LegendOptionsTypeDef], # (6)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (7)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (8)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (9)
- See HeatMapFieldWellsTypeDef
- See HeatMapSortConfigurationTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ColorScaleTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualInteractionOptionsTypeDef
HistogramConfigurationTypeDef#
# HistogramConfigurationTypeDef definition
class HistogramConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[HistogramFieldWellsTypeDef], # (1)
XAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (2)
XAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
YAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (2)
BinOptions: NotRequired[HistogramBinOptionsTypeDef], # (5)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (6)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (7)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (8)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (9)
- See HistogramFieldWellsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See HistogramBinOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
KPIVisualTypeDef#
# KPIVisualTypeDef definition
class KPIVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[KPIConfigurationTypeDef], # (3)
ConditionalFormatting: NotRequired[KPIConditionalFormattingTypeDef], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (6)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See KPIConfigurationTypeDef
- See KPIConditionalFormattingTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
LineChartConfigurationTypeDef#
# LineChartConfigurationTypeDef definition
class LineChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[LineChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[LineChartSortConfigurationTypeDef], # (2)
ForecastConfigurations: NotRequired[Sequence[ForecastConfigurationTypeDef]], # (3)
Type: NotRequired[LineChartTypeType], # (4)
SmallMultiplesOptions: NotRequired[SmallMultiplesOptionsTypeDef], # (5)
XAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (6)
XAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (7)
PrimaryYAxisDisplayOptions: NotRequired[LineSeriesAxisDisplayOptionsTypeDef], # (8)
PrimaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (7)
SecondaryYAxisDisplayOptions: NotRequired[LineSeriesAxisDisplayOptionsTypeDef], # (8)
SecondaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (7)
SingleAxisOptions: NotRequired[SingleAxisOptionsTypeDef], # (12)
DefaultSeriesSettings: NotRequired[LineChartDefaultSeriesSettingsTypeDef], # (13)
Series: NotRequired[Sequence[SeriesItemTypeDef]], # (14)
Legend: NotRequired[LegendOptionsTypeDef], # (15)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (16)
ReferenceLines: NotRequired[Sequence[ReferenceLineTypeDef]], # (17)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (18)
ContributionAnalysisDefaults: NotRequired[Sequence[ContributionAnalysisDefaultTypeDef]], # (19)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (20)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (21)
- See LineChartFieldWellsTypeDef
- See LineChartSortConfigurationTypeDef
- See ForecastConfigurationTypeDef
- See LineChartTypeType
- See SmallMultiplesOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LineSeriesAxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LineSeriesAxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See SingleAxisOptionsTypeDef
- See LineChartDefaultSeriesSettingsTypeDef
- See SeriesItemTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See ReferenceLineTypeDef
- See TooltipOptionsTypeDef
- See ContributionAnalysisDefaultTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
PieChartConfigurationTypeDef#
# PieChartConfigurationTypeDef definition
class PieChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[PieChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[PieChartSortConfigurationTypeDef], # (2)
DonutOptions: NotRequired[DonutOptionsTypeDef], # (3)
SmallMultiplesOptions: NotRequired[SmallMultiplesOptionsTypeDef], # (4)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
ValueLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (5)
Legend: NotRequired[LegendOptionsTypeDef], # (7)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (8)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (9)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (10)
ContributionAnalysisDefaults: NotRequired[Sequence[ContributionAnalysisDefaultTypeDef]], # (11)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (12)
- See PieChartFieldWellsTypeDef
- See PieChartSortConfigurationTypeDef
- See DonutOptionsTypeDef
- See SmallMultiplesOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualPaletteTypeDef
- See ContributionAnalysisDefaultTypeDef
- See VisualInteractionOptionsTypeDef
PivotTableConfigurationTypeDef#
# PivotTableConfigurationTypeDef definition
class PivotTableConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[PivotTableFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[PivotTableSortConfigurationTypeDef], # (2)
TableOptions: NotRequired[PivotTableOptionsTypeDef], # (3)
TotalOptions: NotRequired[PivotTableTotalOptionsTypeDef], # (4)
FieldOptions: NotRequired[PivotTableFieldOptionsTypeDef], # (5)
PaginatedReportOptions: NotRequired[PivotTablePaginatedReportOptionsTypeDef], # (6)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (7)
- See PivotTableFieldWellsTypeDef
- See PivotTableSortConfigurationTypeDef
- See PivotTableOptionsTypeDef
- See PivotTableTotalOptionsTypeDef
- See PivotTableFieldOptionsTypeDef
- See PivotTablePaginatedReportOptionsTypeDef
- See VisualInteractionOptionsTypeDef
RadarChartConfigurationTypeDef#
# RadarChartConfigurationTypeDef definition
class RadarChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[RadarChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[RadarChartSortConfigurationTypeDef], # (2)
Shape: NotRequired[RadarChartShapeType], # (3)
BaseSeriesSettings: NotRequired[RadarChartSeriesSettingsTypeDef], # (4)
StartAngle: NotRequired[float],
VisualPalette: NotRequired[VisualPaletteTypeDef], # (5)
AlternateBandColorsVisibility: NotRequired[VisibilityType], # (6)
AlternateBandEvenColor: NotRequired[str],
AlternateBandOddColor: NotRequired[str],
CategoryAxis: NotRequired[AxisDisplayOptionsTypeDef], # (7)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (8)
ColorAxis: NotRequired[AxisDisplayOptionsTypeDef], # (7)
ColorLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (8)
Legend: NotRequired[LegendOptionsTypeDef], # (11)
AxesRangeScale: NotRequired[RadarChartAxesRangeScaleType], # (12)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (13)
- See RadarChartFieldWellsTypeDef
- See RadarChartSortConfigurationTypeDef
- See RadarChartShapeType
- See RadarChartSeriesSettingsTypeDef
- See VisualPaletteTypeDef
- See VisibilityType
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See LegendOptionsTypeDef
- See RadarChartAxesRangeScaleType
- See VisualInteractionOptionsTypeDef
SankeyDiagramChartConfigurationTypeDef#
# SankeyDiagramChartConfigurationTypeDef definition
class SankeyDiagramChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[SankeyDiagramFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[SankeyDiagramSortConfigurationTypeDef], # (2)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (3)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (4)
- See SankeyDiagramFieldWellsTypeDef
- See SankeyDiagramSortConfigurationTypeDef
- See DataLabelOptionsTypeDef
- See VisualInteractionOptionsTypeDef
ScatterPlotConfigurationTypeDef#
# ScatterPlotConfigurationTypeDef definition
class ScatterPlotConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[ScatterPlotFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[ScatterPlotSortConfigurationTypeDef], # (2)
XAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
XAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (4)
YAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
YAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (4)
Legend: NotRequired[LegendOptionsTypeDef], # (7)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (8)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (9)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (10)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (11)
- See ScatterPlotFieldWellsTypeDef
- See ScatterPlotSortConfigurationTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualPaletteTypeDef
- See VisualInteractionOptionsTypeDef
InsightConfigurationTypeDef#
# InsightConfigurationTypeDef definition
class InsightConfigurationTypeDef(TypedDict):
Computations: NotRequired[Sequence[ComputationTypeDef]], # (1)
CustomNarrative: NotRequired[CustomNarrativeOptionsTypeDef], # (2)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (3)
TreeMapConfigurationTypeDef#
# TreeMapConfigurationTypeDef definition
class TreeMapConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[TreeMapFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[TreeMapSortConfigurationTypeDef], # (2)
GroupLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
SizeLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
ColorLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
ColorScale: NotRequired[ColorScaleTypeDef], # (6)
Legend: NotRequired[LegendOptionsTypeDef], # (7)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (8)
Tooltip: NotRequired[TooltipOptionsTypeDef], # (9)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (10)
- See TreeMapFieldWellsTypeDef
- See TreeMapSortConfigurationTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See ColorScaleTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See TooltipOptionsTypeDef
- See VisualInteractionOptionsTypeDef
WaterfallChartConfigurationTypeDef#
# WaterfallChartConfigurationTypeDef definition
class WaterfallChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[WaterfallChartFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[WaterfallChartSortConfigurationTypeDef], # (2)
WaterfallChartOptions: NotRequired[WaterfallChartOptionsTypeDef], # (3)
CategoryAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (4)
CategoryAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (5)
PrimaryYAxisLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (4)
PrimaryYAxisDisplayOptions: NotRequired[AxisDisplayOptionsTypeDef], # (5)
Legend: NotRequired[LegendOptionsTypeDef], # (8)
DataLabels: NotRequired[DataLabelOptionsTypeDef], # (9)
VisualPalette: NotRequired[VisualPaletteTypeDef], # (10)
ColorConfiguration: NotRequired[WaterfallChartColorConfigurationTypeDef], # (11)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (12)
- See WaterfallChartFieldWellsTypeDef
- See WaterfallChartSortConfigurationTypeDef
- See WaterfallChartOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See ChartAxisLabelOptionsTypeDef
- See AxisDisplayOptionsTypeDef
- See LegendOptionsTypeDef
- See DataLabelOptionsTypeDef
- See VisualPaletteTypeDef
- See WaterfallChartColorConfigurationTypeDef
- See VisualInteractionOptionsTypeDef
WordCloudChartConfigurationTypeDef#
# WordCloudChartConfigurationTypeDef definition
class WordCloudChartConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[WordCloudFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[WordCloudSortConfigurationTypeDef], # (2)
CategoryLabelOptions: NotRequired[ChartAxisLabelOptionsTypeDef], # (3)
WordCloudOptions: NotRequired[WordCloudOptionsTypeDef], # (4)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (5)
- See WordCloudFieldWellsTypeDef
- See WordCloudSortConfigurationTypeDef
- See ChartAxisLabelOptionsTypeDef
- See WordCloudOptionsTypeDef
- See VisualInteractionOptionsTypeDef
TableConfigurationTypeDef#
# TableConfigurationTypeDef definition
class TableConfigurationTypeDef(TypedDict):
FieldWells: NotRequired[TableFieldWellsTypeDef], # (1)
SortConfiguration: NotRequired[TableSortConfigurationTypeDef], # (2)
TableOptions: NotRequired[TableOptionsTypeDef], # (3)
TotalOptions: NotRequired[TotalOptionsTypeDef], # (4)
FieldOptions: NotRequired[TableFieldOptionsTypeDef], # (5)
PaginatedReportOptions: NotRequired[TablePaginatedReportOptionsTypeDef], # (6)
TableInlineVisualizations: NotRequired[Sequence[TableInlineVisualizationTypeDef]], # (7)
Interactions: NotRequired[VisualInteractionOptionsTypeDef], # (8)
- See TableFieldWellsTypeDef
- See TableSortConfigurationTypeDef
- See TableOptionsTypeDef
- See TotalOptionsTypeDef
- See TableFieldOptionsTypeDef
- See TablePaginatedReportOptionsTypeDef
- See TableInlineVisualizationTypeDef
- See VisualInteractionOptionsTypeDef
LayoutTypeDef#
# LayoutTypeDef definition
class LayoutTypeDef(TypedDict):
Configuration: LayoutConfigurationTypeDef, # (1)
BarChartVisualTypeDef#
# BarChartVisualTypeDef definition
class BarChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[BarChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See BarChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
BoxPlotVisualTypeDef#
# BoxPlotVisualTypeDef definition
class BoxPlotVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[BoxPlotChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See BoxPlotChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
ComboChartVisualTypeDef#
# ComboChartVisualTypeDef definition
class ComboChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[ComboChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See ComboChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
FilledMapVisualTypeDef#
# FilledMapVisualTypeDef definition
class FilledMapVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[FilledMapConfigurationTypeDef], # (3)
ConditionalFormatting: NotRequired[FilledMapConditionalFormattingTypeDef], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (6)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See FilledMapConfigurationTypeDef
- See FilledMapConditionalFormattingTypeDef
- See ColumnHierarchyTypeDef
- See VisualCustomActionTypeDef
FunnelChartVisualTypeDef#
# FunnelChartVisualTypeDef definition
class FunnelChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[FunnelChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See FunnelChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
GeospatialMapVisualTypeDef#
# GeospatialMapVisualTypeDef definition
class GeospatialMapVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[GeospatialMapConfigurationTypeDef], # (3)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See GeospatialMapConfigurationTypeDef
- See ColumnHierarchyTypeDef
- See VisualCustomActionTypeDef
HeatMapVisualTypeDef#
# HeatMapVisualTypeDef definition
class HeatMapVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[HeatMapConfigurationTypeDef], # (3)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See HeatMapConfigurationTypeDef
- See ColumnHierarchyTypeDef
- See VisualCustomActionTypeDef
HistogramVisualTypeDef#
# HistogramVisualTypeDef definition
class HistogramVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[HistogramConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See HistogramConfigurationTypeDef
- See VisualCustomActionTypeDef
LineChartVisualTypeDef#
# LineChartVisualTypeDef definition
class LineChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[LineChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See LineChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
PieChartVisualTypeDef#
# PieChartVisualTypeDef definition
class PieChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[PieChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See PieChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
PivotTableVisualTypeDef#
# PivotTableVisualTypeDef definition
class PivotTableVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[PivotTableConfigurationTypeDef], # (3)
ConditionalFormatting: NotRequired[PivotTableConditionalFormattingTypeDef], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See PivotTableConfigurationTypeDef
- See PivotTableConditionalFormattingTypeDef
- See VisualCustomActionTypeDef
RadarChartVisualTypeDef#
# RadarChartVisualTypeDef definition
class RadarChartVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[RadarChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See RadarChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
SankeyDiagramVisualTypeDef#
# SankeyDiagramVisualTypeDef definition
class SankeyDiagramVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[SankeyDiagramChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See SankeyDiagramChartConfigurationTypeDef
- See VisualCustomActionTypeDef
ScatterPlotVisualTypeDef#
# ScatterPlotVisualTypeDef definition
class ScatterPlotVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[ScatterPlotConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See ScatterPlotConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
InsightVisualTypeDef#
# InsightVisualTypeDef definition
class InsightVisualTypeDef(TypedDict):
VisualId: str,
DataSetIdentifier: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
InsightConfiguration: NotRequired[InsightConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See InsightConfigurationTypeDef
- See VisualCustomActionTypeDef
TreeMapVisualTypeDef#
# TreeMapVisualTypeDef definition
class TreeMapVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[TreeMapConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See TreeMapConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
WaterfallVisualTypeDef#
# WaterfallVisualTypeDef definition
class WaterfallVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[WaterfallChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See WaterfallChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
WordCloudVisualTypeDef#
# WordCloudVisualTypeDef definition
class WordCloudVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[WordCloudChartConfigurationTypeDef], # (3)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (4)
ColumnHierarchies: NotRequired[Sequence[ColumnHierarchyTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See WordCloudChartConfigurationTypeDef
- See VisualCustomActionTypeDef
- See ColumnHierarchyTypeDef
TableVisualTypeDef#
# TableVisualTypeDef definition
class TableVisualTypeDef(TypedDict):
VisualId: str,
Title: NotRequired[VisualTitleLabelOptionsTypeDef], # (1)
Subtitle: NotRequired[VisualSubtitleLabelOptionsTypeDef], # (2)
ChartConfiguration: NotRequired[TableConfigurationTypeDef], # (3)
ConditionalFormatting: NotRequired[TableConditionalFormattingTypeDef], # (4)
Actions: NotRequired[Sequence[VisualCustomActionTypeDef]], # (5)
- See VisualTitleLabelOptionsTypeDef
- See VisualSubtitleLabelOptionsTypeDef
- See TableConfigurationTypeDef
- See TableConditionalFormattingTypeDef
- See VisualCustomActionTypeDef
VisualTypeDef#
# VisualTypeDef definition
class VisualTypeDef(TypedDict):
TableVisual: NotRequired[TableVisualTypeDef], # (1)
PivotTableVisual: NotRequired[PivotTableVisualTypeDef], # (2)
BarChartVisual: NotRequired[BarChartVisualTypeDef], # (3)
KPIVisual: NotRequired[KPIVisualTypeDef], # (4)
PieChartVisual: NotRequired[PieChartVisualTypeDef], # (5)
GaugeChartVisual: NotRequired[GaugeChartVisualTypeDef], # (6)
LineChartVisual: NotRequired[LineChartVisualTypeDef], # (7)
HeatMapVisual: NotRequired[HeatMapVisualTypeDef], # (8)
TreeMapVisual: NotRequired[TreeMapVisualTypeDef], # (9)
GeospatialMapVisual: NotRequired[GeospatialMapVisualTypeDef], # (10)
FilledMapVisual: NotRequired[FilledMapVisualTypeDef], # (11)
FunnelChartVisual: NotRequired[FunnelChartVisualTypeDef], # (12)
ScatterPlotVisual: NotRequired[ScatterPlotVisualTypeDef], # (13)
ComboChartVisual: NotRequired[ComboChartVisualTypeDef], # (14)
BoxPlotVisual: NotRequired[BoxPlotVisualTypeDef], # (15)
WaterfallVisual: NotRequired[WaterfallVisualTypeDef], # (16)
HistogramVisual: NotRequired[HistogramVisualTypeDef], # (17)
WordCloudVisual: NotRequired[WordCloudVisualTypeDef], # (18)
InsightVisual: NotRequired[InsightVisualTypeDef], # (19)
SankeyDiagramVisual: NotRequired[SankeyDiagramVisualTypeDef], # (20)
CustomContentVisual: NotRequired[CustomContentVisualTypeDef], # (21)
EmptyVisual: NotRequired[EmptyVisualTypeDef], # (22)
RadarChartVisual: NotRequired[RadarChartVisualTypeDef], # (23)
- See TableVisualTypeDef
- See PivotTableVisualTypeDef
- See BarChartVisualTypeDef
- See KPIVisualTypeDef
- See PieChartVisualTypeDef
- See GaugeChartVisualTypeDef
- See LineChartVisualTypeDef
- See HeatMapVisualTypeDef
- See TreeMapVisualTypeDef
- See GeospatialMapVisualTypeDef
- See FilledMapVisualTypeDef
- See FunnelChartVisualTypeDef
- See ScatterPlotVisualTypeDef
- See ComboChartVisualTypeDef
- See BoxPlotVisualTypeDef
- See WaterfallVisualTypeDef
- See HistogramVisualTypeDef
- See WordCloudVisualTypeDef
- See InsightVisualTypeDef
- See SankeyDiagramVisualTypeDef
- See CustomContentVisualTypeDef
- See EmptyVisualTypeDef
- See RadarChartVisualTypeDef
SheetDefinitionTypeDef#
# SheetDefinitionTypeDef definition
class SheetDefinitionTypeDef(TypedDict):
SheetId: str,
Title: NotRequired[str],
Description: NotRequired[str],
Name: NotRequired[str],
ParameterControls: NotRequired[Sequence[ParameterControlTypeDef]], # (1)
FilterControls: NotRequired[Sequence[FilterControlTypeDef]], # (2)
Visuals: NotRequired[Sequence[VisualTypeDef]], # (3)
TextBoxes: NotRequired[Sequence[SheetTextBoxTypeDef]], # (4)
Layouts: NotRequired[Sequence[LayoutTypeDef]], # (5)
SheetControlLayouts: NotRequired[Sequence[SheetControlLayoutTypeDef]], # (6)
ContentType: NotRequired[SheetContentTypeType], # (7)
- See ParameterControlTypeDef
- See FilterControlTypeDef
- See VisualTypeDef
- See SheetTextBoxTypeDef
- See LayoutTypeDef
- See SheetControlLayoutTypeDef
- See SheetContentTypeType
AnalysisDefinitionTypeDef#
# AnalysisDefinitionTypeDef definition
class AnalysisDefinitionTypeDef(TypedDict):
DataSetIdentifierDeclarations: Sequence[DataSetIdentifierDeclarationTypeDef], # (1)
Sheets: NotRequired[Sequence[SheetDefinitionTypeDef]], # (2)
CalculatedFields: NotRequired[Sequence[CalculatedFieldTypeDef]], # (3)
ParameterDeclarations: NotRequired[Sequence[ParameterDeclarationTypeDef]], # (4)
FilterGroups: NotRequired[Sequence[FilterGroupTypeDef]], # (5)
ColumnConfigurations: NotRequired[Sequence[ColumnConfigurationTypeDef]], # (6)
AnalysisDefaults: NotRequired[AnalysisDefaultsTypeDef], # (7)
Options: NotRequired[AssetOptionsTypeDef], # (8)
- See DataSetIdentifierDeclarationTypeDef
- See SheetDefinitionTypeDef
- See CalculatedFieldTypeDef
- See ParameterDeclarationTypeDef
- See FilterGroupTypeDef
- See ColumnConfigurationTypeDef
- See AnalysisDefaultsTypeDef
- See AssetOptionsTypeDef
DashboardVersionDefinitionTypeDef#
# DashboardVersionDefinitionTypeDef definition
class DashboardVersionDefinitionTypeDef(TypedDict):
DataSetIdentifierDeclarations: Sequence[DataSetIdentifierDeclarationTypeDef], # (1)
Sheets: NotRequired[Sequence[SheetDefinitionTypeDef]], # (2)
CalculatedFields: NotRequired[Sequence[CalculatedFieldTypeDef]], # (3)
ParameterDeclarations: NotRequired[Sequence[ParameterDeclarationTypeDef]], # (4)
FilterGroups: NotRequired[Sequence[FilterGroupTypeDef]], # (5)
ColumnConfigurations: NotRequired[Sequence[ColumnConfigurationTypeDef]], # (6)
AnalysisDefaults: NotRequired[AnalysisDefaultsTypeDef], # (7)
Options: NotRequired[AssetOptionsTypeDef], # (8)
- See DataSetIdentifierDeclarationTypeDef
- See SheetDefinitionTypeDef
- See CalculatedFieldTypeDef
- See ParameterDeclarationTypeDef
- See FilterGroupTypeDef
- See ColumnConfigurationTypeDef
- See AnalysisDefaultsTypeDef
- See AssetOptionsTypeDef
TemplateVersionDefinitionTypeDef#
# TemplateVersionDefinitionTypeDef definition
class TemplateVersionDefinitionTypeDef(TypedDict):
DataSetConfigurations: Sequence[DataSetConfigurationTypeDef], # (1)
Sheets: NotRequired[Sequence[SheetDefinitionTypeDef]], # (2)
CalculatedFields: NotRequired[Sequence[CalculatedFieldTypeDef]], # (3)
ParameterDeclarations: NotRequired[Sequence[ParameterDeclarationTypeDef]], # (4)
FilterGroups: NotRequired[Sequence[FilterGroupTypeDef]], # (5)
ColumnConfigurations: NotRequired[Sequence[ColumnConfigurationTypeDef]], # (6)
AnalysisDefaults: NotRequired[AnalysisDefaultsTypeDef], # (7)
Options: NotRequired[AssetOptionsTypeDef], # (8)
- See DataSetConfigurationTypeDef
- See SheetDefinitionTypeDef
- See CalculatedFieldTypeDef
- See ParameterDeclarationTypeDef
- See FilterGroupTypeDef
- See ColumnConfigurationTypeDef
- See AnalysisDefaultsTypeDef
- See AssetOptionsTypeDef
CreateAnalysisRequestRequestTypeDef#
# CreateAnalysisRequestRequestTypeDef definition
class CreateAnalysisRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: NotRequired[ParametersTypeDef], # (1)
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (2)
SourceEntity: NotRequired[AnalysisSourceEntityTypeDef], # (3)
ThemeArn: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
Definition: NotRequired[AnalysisDefinitionTypeDef], # (5)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (6)
FolderArns: NotRequired[Sequence[str]],
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See AnalysisSourceEntityTypeDef
- See TagTypeDef
- See AnalysisDefinitionTypeDef
- See ValidationStrategyTypeDef
DescribeAnalysisDefinitionResponseTypeDef#
# DescribeAnalysisDefinitionResponseTypeDef definition
class DescribeAnalysisDefinitionResponseTypeDef(TypedDict):
AnalysisId: str,
Name: str,
Errors: List[AnalysisErrorTypeDef], # (1)
ResourceStatus: ResourceStatusType, # (2)
ThemeArn: str,
Definition: AnalysisDefinitionTypeDef, # (3)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AnalysisErrorTypeDef
- See ResourceStatusType
- See AnalysisDefinitionTypeDef
- See ResponseMetadataTypeDef
UpdateAnalysisRequestRequestTypeDef#
# UpdateAnalysisRequestRequestTypeDef definition
class UpdateAnalysisRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: NotRequired[ParametersTypeDef], # (1)
SourceEntity: NotRequired[AnalysisSourceEntityTypeDef], # (2)
ThemeArn: NotRequired[str],
Definition: NotRequired[AnalysisDefinitionTypeDef], # (3)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (4)
- See ParametersTypeDef
- See AnalysisSourceEntityTypeDef
- See AnalysisDefinitionTypeDef
- See ValidationStrategyTypeDef
CreateDashboardRequestRequestTypeDef#
# CreateDashboardRequestRequestTypeDef definition
class CreateDashboardRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
Name: str,
Parameters: NotRequired[ParametersTypeDef], # (1)
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (2)
SourceEntity: NotRequired[DashboardSourceEntityTypeDef], # (3)
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
VersionDescription: NotRequired[str],
DashboardPublishOptions: NotRequired[DashboardPublishOptionsTypeDef], # (5)
ThemeArn: NotRequired[str],
Definition: NotRequired[DashboardVersionDefinitionTypeDef], # (6)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (7)
FolderArns: NotRequired[Sequence[str]],
LinkSharingConfiguration: NotRequired[LinkSharingConfigurationTypeDef], # (8)
LinkEntities: NotRequired[Sequence[str]],
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See DashboardSourceEntityTypeDef
- See TagTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
- See LinkSharingConfigurationTypeDef
DescribeDashboardDefinitionResponseTypeDef#
# DescribeDashboardDefinitionResponseTypeDef definition
class DescribeDashboardDefinitionResponseTypeDef(TypedDict):
DashboardId: str,
Errors: List[DashboardErrorTypeDef], # (1)
Name: str,
ResourceStatus: ResourceStatusType, # (2)
ThemeArn: str,
Definition: DashboardVersionDefinitionTypeDef, # (3)
Status: int,
RequestId: str,
DashboardPublishOptions: DashboardPublishOptionsTypeDef, # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)
- See DashboardErrorTypeDef
- See ResourceStatusType
- See DashboardVersionDefinitionTypeDef
- See DashboardPublishOptionsTypeDef
- See ResponseMetadataTypeDef
UpdateDashboardRequestRequestTypeDef#
# UpdateDashboardRequestRequestTypeDef definition
class UpdateDashboardRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
DashboardId: str,
Name: str,
SourceEntity: NotRequired[DashboardSourceEntityTypeDef], # (1)
Parameters: NotRequired[ParametersTypeDef], # (2)
VersionDescription: NotRequired[str],
DashboardPublishOptions: NotRequired[DashboardPublishOptionsTypeDef], # (3)
ThemeArn: NotRequired[str],
Definition: NotRequired[DashboardVersionDefinitionTypeDef], # (4)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (5)
- See DashboardSourceEntityTypeDef
- See ParametersTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
CreateTemplateRequestRequestTypeDef#
# CreateTemplateRequestRequestTypeDef definition
class CreateTemplateRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
Name: NotRequired[str],
Permissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
SourceEntity: NotRequired[TemplateSourceEntityTypeDef], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
VersionDescription: NotRequired[str],
Definition: NotRequired[TemplateVersionDefinitionTypeDef], # (4)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (5)
- See ResourcePermissionTypeDef
- See TemplateSourceEntityTypeDef
- See TagTypeDef
- See TemplateVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
DescribeTemplateDefinitionResponseTypeDef#
# DescribeTemplateDefinitionResponseTypeDef definition
class DescribeTemplateDefinitionResponseTypeDef(TypedDict):
Name: str,
TemplateId: str,
Errors: List[TemplateErrorTypeDef], # (1)
ResourceStatus: ResourceStatusType, # (2)
ThemeArn: str,
Definition: TemplateVersionDefinitionTypeDef, # (3)
Status: int,
RequestId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See TemplateErrorTypeDef
- See ResourceStatusType
- See TemplateVersionDefinitionTypeDef
- See ResponseMetadataTypeDef
UpdateTemplateRequestRequestTypeDef#
# UpdateTemplateRequestRequestTypeDef definition
class UpdateTemplateRequestRequestTypeDef(TypedDict):
AwsAccountId: str,
TemplateId: str,
SourceEntity: NotRequired[TemplateSourceEntityTypeDef], # (1)
VersionDescription: NotRequired[str],
Name: NotRequired[str],
Definition: NotRequired[TemplateVersionDefinitionTypeDef], # (2)
ValidationStrategy: NotRequired[ValidationStrategyTypeDef], # (3)