QuickSightClient#
Index > QuickSight > QuickSightClient
Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.
QuickSightClient#
Type annotations and code completion for boto3.client("quicksight")
.
boto3 documentation
# QuickSightClient usage example
from boto3.session import Session
from mypy_boto3_quicksight.client import QuickSightClient
def get_quicksight_client() -> QuickSightClient:
return Session().client("quicksight")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("quicksight").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("quicksight")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConcurrentUpdatingException,
client.exceptions.ConflictException,
client.exceptions.DomainNotWhitelistedException,
client.exceptions.IdentityTypeNotSupportedException,
client.exceptions.InternalFailureException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.PreconditionNotMetException,
client.exceptions.QuickSightUserNotFoundException,
client.exceptions.ResourceExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceUnavailableException,
client.exceptions.SessionLifetimeInMinutesInvalidException,
client.exceptions.ThrottlingException,
client.exceptions.UnsupportedPricingPlanException,
client.exceptions.UnsupportedUserEditionException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_quicksight.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("quicksight").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_ingestion#
Cancels an ongoing ingestion of data into SPICE.
Type annotations and code completion for boto3.client("quicksight").cancel_ingestion
method.
boto3 documentation
# cancel_ingestion method definition
def cancel_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> CancelIngestionResponseTypeDef: # (1)
...
# cancel_ingestion method usage example with argument unpacking
kwargs: CancelIngestionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"IngestionId": ...,
}
parent.cancel_ingestion(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("quicksight").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_account_customization#
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").create_account_customization
method.
boto3 documentation
# create_account_customization method definition
def create_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAccountCustomizationResponseTypeDef: # (3)
...
# create_account_customization method usage example with argument unpacking
kwargs: CreateAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AccountCustomization": ...,
}
parent.create_account_customization(**kwargs)
create_account_subscription#
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
Type annotations and code completion for boto3.client("quicksight").create_account_subscription
method.
boto3 documentation
# create_account_subscription method definition
def create_account_subscription(
self,
*,
Edition: EditionType, # (1)
AuthenticationMethod: AuthenticationMethodOptionType, # (2)
AwsAccountId: str,
AccountName: str,
NotificationEmail: str,
ActiveDirectoryName: str = ...,
Realm: str = ...,
DirectoryId: str = ...,
AdminGroup: Sequence[str] = ...,
AuthorGroup: Sequence[str] = ...,
ReaderGroup: Sequence[str] = ...,
FirstName: str = ...,
LastName: str = ...,
EmailAddress: str = ...,
ContactNumber: str = ...,
) -> CreateAccountSubscriptionResponseTypeDef: # (3)
...
# create_account_subscription method usage example with argument unpacking
kwargs: CreateAccountSubscriptionRequestRequestTypeDef = { # (1)
"Edition": ...,
"AuthenticationMethod": ...,
"AwsAccountId": ...,
"AccountName": ...,
"NotificationEmail": ...,
}
parent.create_account_subscription(**kwargs)
create_analysis#
Creates an analysis in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_analysis
method.
boto3 documentation
# create_analysis method definition
def create_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
SourceEntity: AnalysisSourceEntityTypeDef = ..., # (3)
ThemeArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
Definition: AnalysisDefinitionTypeDef = ..., # (5)
) -> CreateAnalysisResponseTypeDef: # (6)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See AnalysisSourceEntityTypeDef
- See TagTypeDef
- See AnalysisDefinitionTypeDef
- See CreateAnalysisResponseTypeDef
# create_analysis method usage example with argument unpacking
kwargs: CreateAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
"Name": ...,
}
parent.create_analysis(**kwargs)
create_dashboard#
Creates a dashboard from either a template or directly with a
DashboardDefinition
.
Type annotations and code completion for boto3.client("quicksight").create_dashboard
method.
boto3 documentation
# create_dashboard method definition
def create_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
SourceEntity: DashboardSourceEntityTypeDef = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
VersionDescription: str = ...,
DashboardPublishOptions: DashboardPublishOptionsTypeDef = ..., # (5)
ThemeArn: str = ...,
Definition: DashboardVersionDefinitionTypeDef = ..., # (6)
) -> CreateDashboardResponseTypeDef: # (7)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See DashboardSourceEntityTypeDef
- See TagTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See CreateDashboardResponseTypeDef
# create_dashboard method usage example with argument unpacking
kwargs: CreateDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"Name": ...,
}
parent.create_dashboard(**kwargs)
create_data_set#
Creates a dataset.
Type annotations and code completion for boto3.client("quicksight").create_data_set
method.
boto3 documentation
# create_data_set method definition
def create_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
Name: str,
PhysicalTableMap: Mapping[str, PhysicalTableTypeDef], # (1)
ImportMode: DataSetImportModeType, # (2)
LogicalTableMap: Mapping[str, LogicalTableTypeDef] = ..., # (3)
ColumnGroups: Sequence[ColumnGroupTypeDef] = ..., # (4)
FieldFolders: Mapping[str, FieldFolderTypeDef] = ..., # (5)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (6)
RowLevelPermissionDataSet: RowLevelPermissionDataSetTypeDef = ..., # (7)
RowLevelPermissionTagConfiguration: RowLevelPermissionTagConfigurationTypeDef = ..., # (8)
ColumnLevelPermissionRules: Sequence[ColumnLevelPermissionRuleTypeDef] = ..., # (9)
Tags: Sequence[TagTypeDef] = ..., # (10)
DataSetUsageConfiguration: DataSetUsageConfigurationTypeDef = ..., # (11)
DatasetParameters: Sequence[DatasetParameterTypeDef] = ..., # (12)
) -> CreateDataSetResponseTypeDef: # (13)
...
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See ResourcePermissionTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See TagTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef
- See CreateDataSetResponseTypeDef
# create_data_set method usage example with argument unpacking
kwargs: CreateDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"Name": ...,
"PhysicalTableMap": ...,
"ImportMode": ...,
}
parent.create_data_set(**kwargs)
create_data_source#
Creates a data source.
Type annotations and code completion for boto3.client("quicksight").create_data_source
method.
boto3 documentation
# create_data_source method definition
def create_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
Name: str,
Type: DataSourceTypeType, # (1)
DataSourceParameters: DataSourceParametersTypeDef = ..., # (2)
Credentials: DataSourceCredentialsTypeDef = ..., # (3)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (4)
VpcConnectionProperties: VpcConnectionPropertiesTypeDef = ..., # (5)
SslProperties: SslPropertiesTypeDef = ..., # (6)
Tags: Sequence[TagTypeDef] = ..., # (7)
) -> CreateDataSourceResponseTypeDef: # (8)
...
- See DataSourceTypeType
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See ResourcePermissionTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See TagTypeDef
- See CreateDataSourceResponseTypeDef
# create_data_source method usage example with argument unpacking
kwargs: CreateDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
"Name": ...,
"Type": ...,
}
parent.create_data_source(**kwargs)
create_folder#
Creates an empty shared folder.
Type annotations and code completion for boto3.client("quicksight").create_folder
method.
boto3 documentation
# create_folder method definition
def create_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
Name: str = ...,
FolderType: FolderTypeType = ..., # (1)
ParentFolderArn: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateFolderResponseTypeDef: # (4)
...
- See FolderTypeType
- See ResourcePermissionTypeDef
- See TagTypeDef
- See CreateFolderResponseTypeDef
# create_folder method usage example with argument unpacking
kwargs: CreateFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.create_folder(**kwargs)
create_folder_membership#
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
Type annotations and code completion for boto3.client("quicksight").create_folder_membership
method.
boto3 documentation
# create_folder_membership method definition
def create_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> CreateFolderMembershipResponseTypeDef: # (2)
...
# create_folder_membership method usage example with argument unpacking
kwargs: CreateFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.create_folder_membership(**kwargs)
create_group#
Use the CreateGroup
operation to create a group in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_group
method.
boto3 documentation
# create_group method definition
def create_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
# create_group method usage example with argument unpacking
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group(**kwargs)
create_group_membership#
Adds an Amazon QuickSight user to an Amazon QuickSight group.
Type annotations and code completion for boto3.client("quicksight").create_group_membership
method.
boto3 documentation
# create_group_membership method definition
def create_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> CreateGroupMembershipResponseTypeDef: # (1)
...
# create_group_membership method usage example with argument unpacking
kwargs: CreateGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group_membership(**kwargs)
create_iam_policy_assignment#
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("quicksight").create_iam_policy_assignment
method.
boto3 documentation
# create_iam_policy_assignment method definition
def create_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
AssignmentStatus: AssignmentStatusType, # (1)
Namespace: str,
PolicyArn: str = ...,
Identities: Mapping[str, Sequence[str]] = ...,
) -> CreateIAMPolicyAssignmentResponseTypeDef: # (2)
...
# create_iam_policy_assignment method usage example with argument unpacking
kwargs: CreateIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"AssignmentStatus": ...,
"Namespace": ...,
}
parent.create_iam_policy_assignment(**kwargs)
create_ingestion#
Creates and starts a new SPICE ingestion for a dataset.
Type annotations and code completion for boto3.client("quicksight").create_ingestion
method.
boto3 documentation
# create_ingestion method definition
def create_ingestion(
self,
*,
DataSetId: str,
IngestionId: str,
AwsAccountId: str,
IngestionType: IngestionTypeType = ..., # (1)
) -> CreateIngestionResponseTypeDef: # (2)
...
# create_ingestion method usage example with argument unpacking
kwargs: CreateIngestionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"IngestionId": ...,
"AwsAccountId": ...,
}
parent.create_ingestion(**kwargs)
create_namespace#
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_namespace
method.
boto3 documentation
# create_namespace method definition
def create_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
IdentityStore: IdentityStoreType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateNamespaceResponseTypeDef: # (3)
...
# create_namespace method usage example with argument unpacking
kwargs: CreateNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"IdentityStore": ...,
}
parent.create_namespace(**kwargs)
create_refresh_schedule#
Creates a refresh schedule for a dataset.
Type annotations and code completion for boto3.client("quicksight").create_refresh_schedule
method.
boto3 documentation
# create_refresh_schedule method definition
def create_refresh_schedule(
self,
*,
DataSetId: str,
AwsAccountId: str,
Schedule: RefreshScheduleTypeDef, # (1)
) -> CreateRefreshScheduleResponseTypeDef: # (2)
...
# create_refresh_schedule method usage example with argument unpacking
kwargs: CreateRefreshScheduleRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
"Schedule": ...,
}
parent.create_refresh_schedule(**kwargs)
create_template#
Creates a template either from a TemplateDefinition
or from an existing Amazon
QuickSight analysis or template.
Type annotations and code completion for boto3.client("quicksight").create_template
method.
boto3 documentation
# create_template method definition
def create_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
Name: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
SourceEntity: TemplateSourceEntityTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
VersionDescription: str = ...,
Definition: TemplateVersionDefinitionTypeDef = ..., # (4)
) -> CreateTemplateResponseTypeDef: # (5)
...
- See ResourcePermissionTypeDef
- See TemplateSourceEntityTypeDef
- See TagTypeDef
- See TemplateVersionDefinitionTypeDef
- See CreateTemplateResponseTypeDef
# create_template method usage example with argument unpacking
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.create_template(**kwargs)
create_template_alias#
Creates a template alias for a template.
Type annotations and code completion for boto3.client("quicksight").create_template_alias
method.
boto3 documentation
# create_template_alias method definition
def create_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
) -> CreateTemplateAliasResponseTypeDef: # (1)
...
# create_template_alias method usage example with argument unpacking
kwargs: CreateTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
"TemplateVersionNumber": ...,
}
parent.create_template_alias(**kwargs)
create_theme#
Creates a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme
method.
boto3 documentation
# create_theme method definition
def create_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
Name: str,
BaseThemeId: str,
Configuration: ThemeConfigurationTypeDef, # (1)
VersionDescription: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateThemeResponseTypeDef: # (4)
...
- See ThemeConfigurationTypeDef
- See ResourcePermissionTypeDef
- See TagTypeDef
- See CreateThemeResponseTypeDef
# create_theme method usage example with argument unpacking
kwargs: CreateThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"Name": ...,
"BaseThemeId": ...,
"Configuration": ...,
}
parent.create_theme(**kwargs)
create_theme_alias#
Creates a theme alias for a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme_alias
method.
boto3 documentation
# create_theme_alias method definition
def create_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
) -> CreateThemeAliasResponseTypeDef: # (1)
...
# create_theme_alias method usage example with argument unpacking
kwargs: CreateThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
"ThemeVersionNumber": ...,
}
parent.create_theme_alias(**kwargs)
create_topic#
Creates a new Q topic.
Type annotations and code completion for boto3.client("quicksight").create_topic
method.
boto3 documentation
# create_topic method definition
def create_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateTopicResponseTypeDef: # (3)
...
- See TopicDetailsTypeDef
- See TagTypeDef
- See CreateTopicResponseTypeDef
# create_topic method usage example with argument unpacking
kwargs: CreateTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"Topic": ...,
}
parent.create_topic(**kwargs)
create_topic_refresh_schedule#
Creates a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").create_topic_refresh_schedule
method.
boto3 documentation
# create_topic_refresh_schedule method definition
def create_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetArn: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
DatasetName: str = ...,
) -> CreateTopicRefreshScheduleResponseTypeDef: # (2)
...
# create_topic_refresh_schedule method usage example with argument unpacking
kwargs: CreateTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetArn": ...,
"RefreshSchedule": ...,
}
parent.create_topic_refresh_schedule(**kwargs)
create_vpc_connection#
Creates a new VPC connection.
Type annotations and code completion for boto3.client("quicksight").create_vpc_connection
method.
boto3 documentation
# create_vpc_connection method definition
def create_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
RoleArn: str,
DnsResolvers: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVPCConnectionResponseTypeDef: # (2)
...
# create_vpc_connection method usage example with argument unpacking
kwargs: CreateVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
"Name": ...,
"SubnetIds": ...,
"SecurityGroupIds": ...,
"RoleArn": ...,
}
parent.create_vpc_connection(**kwargs)
delete_account_customization#
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
Type annotations and code completion for boto3.client("quicksight").delete_account_customization
method.
boto3 documentation
# delete_account_customization method definition
def delete_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
) -> DeleteAccountCustomizationResponseTypeDef: # (1)
...
# delete_account_customization method usage example with argument unpacking
kwargs: DeleteAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_customization(**kwargs)
delete_account_subscription#
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight
account.
Type annotations and code completion for boto3.client("quicksight").delete_account_subscription
method.
boto3 documentation
# delete_account_subscription method definition
def delete_account_subscription(
self,
*,
AwsAccountId: str,
) -> DeleteAccountSubscriptionResponseTypeDef: # (1)
...
# delete_account_subscription method usage example with argument unpacking
kwargs: DeleteAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_subscription(**kwargs)
delete_analysis#
Deletes an analysis from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_analysis
method.
boto3 documentation
# delete_analysis method definition
def delete_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
RecoveryWindowInDays: int = ...,
ForceDeleteWithoutRecovery: bool = ...,
) -> DeleteAnalysisResponseTypeDef: # (1)
...
# delete_analysis method usage example with argument unpacking
kwargs: DeleteAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.delete_analysis(**kwargs)
delete_dashboard#
Deletes a dashboard.
Type annotations and code completion for boto3.client("quicksight").delete_dashboard
method.
boto3 documentation
# delete_dashboard method definition
def delete_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
) -> DeleteDashboardResponseTypeDef: # (1)
...
# delete_dashboard method usage example with argument unpacking
kwargs: DeleteDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.delete_dashboard(**kwargs)
delete_data_set#
Deletes a dataset.
Type annotations and code completion for boto3.client("quicksight").delete_data_set
method.
boto3 documentation
# delete_data_set method definition
def delete_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DeleteDataSetResponseTypeDef: # (1)
...
# delete_data_set method usage example with argument unpacking
kwargs: DeleteDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.delete_data_set(**kwargs)
delete_data_set_refresh_properties#
Deletes the dataset refresh properties of the dataset.
Type annotations and code completion for boto3.client("quicksight").delete_data_set_refresh_properties
method.
boto3 documentation
# delete_data_set_refresh_properties method definition
def delete_data_set_refresh_properties(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DeleteDataSetRefreshPropertiesResponseTypeDef: # (1)
...
# delete_data_set_refresh_properties method usage example with argument unpacking
kwargs: DeleteDataSetRefreshPropertiesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.delete_data_set_refresh_properties(**kwargs)
delete_data_source#
Deletes the data source permanently.
Type annotations and code completion for boto3.client("quicksight").delete_data_source
method.
boto3 documentation
# delete_data_source method definition
def delete_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DeleteDataSourceResponseTypeDef: # (1)
...
# delete_data_source method usage example with argument unpacking
kwargs: DeleteDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.delete_data_source(**kwargs)
delete_folder#
Deletes an empty folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder
method.
boto3 documentation
# delete_folder method definition
def delete_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DeleteFolderResponseTypeDef: # (1)
...
# delete_folder method usage example with argument unpacking
kwargs: DeleteFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.delete_folder(**kwargs)
delete_folder_membership#
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder_membership
method.
boto3 documentation
# delete_folder_membership method definition
def delete_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> DeleteFolderMembershipResponseTypeDef: # (2)
...
# delete_folder_membership method usage example with argument unpacking
kwargs: DeleteFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.delete_folder_membership(**kwargs)
delete_group#
Removes a user group from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_group
method.
boto3 documentation
# delete_group method definition
def delete_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupResponseTypeDef: # (1)
...
# delete_group method usage example with argument unpacking
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group(**kwargs)
delete_group_membership#
Removes a user from a group so that the user is no longer a member of the group.
Type annotations and code completion for boto3.client("quicksight").delete_group_membership
method.
boto3 documentation
# delete_group_membership method definition
def delete_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupMembershipResponseTypeDef: # (1)
...
# delete_group_membership method usage example with argument unpacking
kwargs: DeleteGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group_membership(**kwargs)
delete_iam_policy_assignment#
Deletes an existing IAM policy assignment.
Type annotations and code completion for boto3.client("quicksight").delete_iam_policy_assignment
method.
boto3 documentation
# delete_iam_policy_assignment method definition
def delete_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
) -> DeleteIAMPolicyAssignmentResponseTypeDef: # (1)
...
# delete_iam_policy_assignment method usage example with argument unpacking
kwargs: DeleteIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.delete_iam_policy_assignment(**kwargs)
delete_namespace#
Deletes a namespace and the users and groups that are associated with the namespace.
Type annotations and code completion for boto3.client("quicksight").delete_namespace
method.
boto3 documentation
# delete_namespace method definition
def delete_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
) -> DeleteNamespaceResponseTypeDef: # (1)
...
# delete_namespace method usage example with argument unpacking
kwargs: DeleteNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_namespace(**kwargs)
delete_refresh_schedule#
Deletes a refresh schedule from a dataset.
Type annotations and code completion for boto3.client("quicksight").delete_refresh_schedule
method.
boto3 documentation
# delete_refresh_schedule method definition
def delete_refresh_schedule(
self,
*,
DataSetId: str,
AwsAccountId: str,
ScheduleId: str,
) -> DeleteRefreshScheduleResponseTypeDef: # (1)
...
# delete_refresh_schedule method usage example with argument unpacking
kwargs: DeleteRefreshScheduleRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
"ScheduleId": ...,
}
parent.delete_refresh_schedule(**kwargs)
delete_template#
Deletes a template.
Type annotations and code completion for boto3.client("quicksight").delete_template
method.
boto3 documentation
# delete_template method definition
def delete_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
) -> DeleteTemplateResponseTypeDef: # (1)
...
# delete_template method usage example with argument unpacking
kwargs: DeleteTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.delete_template(**kwargs)
delete_template_alias#
Deletes the item that the specified template alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_template_alias
method.
boto3 documentation
# delete_template_alias method definition
def delete_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
) -> DeleteTemplateAliasResponseTypeDef: # (1)
...
# delete_template_alias method usage example with argument unpacking
kwargs: DeleteTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
}
parent.delete_template_alias(**kwargs)
delete_theme#
Deletes a theme.
Type annotations and code completion for boto3.client("quicksight").delete_theme
method.
boto3 documentation
# delete_theme method definition
def delete_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
VersionNumber: int = ...,
) -> DeleteThemeResponseTypeDef: # (1)
...
# delete_theme method usage example with argument unpacking
kwargs: DeleteThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.delete_theme(**kwargs)
delete_theme_alias#
Deletes the version of the theme that the specified theme alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_theme_alias
method.
boto3 documentation
# delete_theme_alias method definition
def delete_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
) -> DeleteThemeAliasResponseTypeDef: # (1)
...
# delete_theme_alias method usage example with argument unpacking
kwargs: DeleteThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
}
parent.delete_theme_alias(**kwargs)
delete_topic#
Deletes a topic.
Type annotations and code completion for boto3.client("quicksight").delete_topic
method.
boto3 documentation
# delete_topic method definition
def delete_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> DeleteTopicResponseTypeDef: # (1)
...
# delete_topic method usage example with argument unpacking
kwargs: DeleteTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.delete_topic(**kwargs)
delete_topic_refresh_schedule#
Deletes a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").delete_topic_refresh_schedule
method.
boto3 documentation
# delete_topic_refresh_schedule method definition
def delete_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetId: str,
) -> DeleteTopicRefreshScheduleResponseTypeDef: # (1)
...
# delete_topic_refresh_schedule method usage example with argument unpacking
kwargs: DeleteTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetId": ...,
}
parent.delete_topic_refresh_schedule(**kwargs)
delete_user#
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
Type annotations and code completion for boto3.client("quicksight").delete_user
method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserResponseTypeDef: # (1)
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user(**kwargs)
delete_user_by_principal_id#
Deletes a user identified by its principal ID.
Type annotations and code completion for boto3.client("quicksight").delete_user_by_principal_id
method.
boto3 documentation
# delete_user_by_principal_id method definition
def delete_user_by_principal_id(
self,
*,
PrincipalId: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserByPrincipalIdResponseTypeDef: # (1)
...
# delete_user_by_principal_id method usage example with argument unpacking
kwargs: DeleteUserByPrincipalIdRequestRequestTypeDef = { # (1)
"PrincipalId": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user_by_principal_id(**kwargs)
delete_vpc_connection#
Deletes a VPC connection.
Type annotations and code completion for boto3.client("quicksight").delete_vpc_connection
method.
boto3 documentation
# delete_vpc_connection method definition
def delete_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
) -> DeleteVPCConnectionResponseTypeDef: # (1)
...
# delete_vpc_connection method usage example with argument unpacking
kwargs: DeleteVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
}
parent.delete_vpc_connection(**kwargs)
describe_account_customization#
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").describe_account_customization
method.
boto3 documentation
# describe_account_customization method definition
def describe_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
Resolved: bool = ...,
) -> DescribeAccountCustomizationResponseTypeDef: # (1)
...
# describe_account_customization method usage example with argument unpacking
kwargs: DescribeAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_customization(**kwargs)
describe_account_settings#
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").describe_account_settings
method.
boto3 documentation
# describe_account_settings method definition
def describe_account_settings(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSettingsResponseTypeDef: # (1)
...
# describe_account_settings method usage example with argument unpacking
kwargs: DescribeAccountSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_settings(**kwargs)
describe_account_subscription#
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
Type annotations and code completion for boto3.client("quicksight").describe_account_subscription
method.
boto3 documentation
# describe_account_subscription method definition
def describe_account_subscription(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSubscriptionResponseTypeDef: # (1)
...
# describe_account_subscription method usage example with argument unpacking
kwargs: DescribeAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_subscription(**kwargs)
describe_analysis#
Provides a summary of the metadata for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis
method.
boto3 documentation
# describe_analysis method definition
def describe_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisResponseTypeDef: # (1)
...
# describe_analysis method usage example with argument unpacking
kwargs: DescribeAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis(**kwargs)
describe_analysis_definition#
Provides a detailed description of the definition of an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_definition
method.
boto3 documentation
# describe_analysis_definition method definition
def describe_analysis_definition(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisDefinitionResponseTypeDef: # (1)
...
# describe_analysis_definition method usage example with argument unpacking
kwargs: DescribeAnalysisDefinitionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_definition(**kwargs)
describe_analysis_permissions#
Provides the read and write permissions for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_permissions
method.
boto3 documentation
# describe_analysis_permissions method definition
def describe_analysis_permissions(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisPermissionsResponseTypeDef: # (1)
...
# describe_analysis_permissions method usage example with argument unpacking
kwargs: DescribeAnalysisPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_permissions(**kwargs)
describe_asset_bundle_export_job#
Describes an existing export job.
Type annotations and code completion for boto3.client("quicksight").describe_asset_bundle_export_job
method.
boto3 documentation
# describe_asset_bundle_export_job method definition
def describe_asset_bundle_export_job(
self,
*,
AwsAccountId: str,
AssetBundleExportJobId: str,
) -> DescribeAssetBundleExportJobResponseTypeDef: # (1)
...
# describe_asset_bundle_export_job method usage example with argument unpacking
kwargs: DescribeAssetBundleExportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleExportJobId": ...,
}
parent.describe_asset_bundle_export_job(**kwargs)
describe_asset_bundle_import_job#
Describes an existing import job.
Type annotations and code completion for boto3.client("quicksight").describe_asset_bundle_import_job
method.
boto3 documentation
# describe_asset_bundle_import_job method definition
def describe_asset_bundle_import_job(
self,
*,
AwsAccountId: str,
AssetBundleImportJobId: str,
) -> DescribeAssetBundleImportJobResponseTypeDef: # (1)
...
# describe_asset_bundle_import_job method usage example with argument unpacking
kwargs: DescribeAssetBundleImportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleImportJobId": ...,
}
parent.describe_asset_bundle_import_job(**kwargs)
describe_dashboard#
Provides a summary for a dashboard.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard
method.