Skip to content

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

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.

Usage example
client = boto3.client("quicksight")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConcurrentUpdatingException,
    client.ConflictException,
    client.DomainNotWhitelistedException,
    client.IdentityTypeNotSupportedException,
    client.InternalFailureException,
    client.InvalidNextTokenException,
    client.InvalidParameterValueException,
    client.LimitExceededException,
    client.PreconditionNotMetException,
    client.QuickSightUserNotFoundException,
    client.ResourceExistsException,
    client.ResourceNotFoundException,
    client.ResourceUnavailableException,
    client.SessionLifetimeInMinutesInvalidException,
    client.ThrottlingException,
    client.UnsupportedPricingPlanException,
    client.UnsupportedUserEditionException,
) as e:
    print(e)
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

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

Method definition
def cancel_ingestion(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
    IngestionId: str,
) -> CancelIngestionResponseTypeDef:  # (1)
    ...
  1. See CancelIngestionResponseTypeDef
Usage example with kwargs
kwargs: CancelIngestionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
    "IngestionId": ...,
}

parent.cancel_ingestion(**kwargs)
  1. See CancelIngestionRequestRequestTypeDef

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("quicksight").close method. boto3 documentation

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

Method definition
def create_account_customization(
    self,
    *,
    AwsAccountId: str,
    AccountCustomization: AccountCustomizationTypeDef,  # (1)
    Namespace: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateAccountCustomizationResponseTypeDef:  # (3)
    ...
  1. See AccountCustomizationTypeDef
  2. See TagTypeDef
  3. See CreateAccountCustomizationResponseTypeDef
Usage example with kwargs
kwargs: CreateAccountCustomizationRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AccountCustomization": ...,
}

parent.create_account_customization(**kwargs)
  1. See CreateAccountCustomizationRequestRequestTypeDef

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

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)
    ...
  1. See EditionType
  2. See AuthenticationMethodOptionType
  3. See CreateAccountSubscriptionResponseTypeDef
Usage example with kwargs
kwargs: CreateAccountSubscriptionRequestRequestTypeDef = {  # (1)
    "Edition": ...,
    "AuthenticationMethod": ...,
    "AwsAccountId": ...,
    "AccountName": ...,
    "NotificationEmail": ...,
}

parent.create_account_subscription(**kwargs)
  1. See CreateAccountSubscriptionRequestRequestTypeDef

create_analysis

Creates an analysis in Amazon QuickSight.

Type annotations and code completion for boto3.client("quicksight").create_analysis method. boto3 documentation

Method definition
def create_analysis(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
    Name: str,
    SourceEntity: AnalysisSourceEntityTypeDef,  # (1)
    Parameters: ParametersTypeDef = ...,  # (2)
    Permissions: Sequence[ResourcePermissionTypeDef] = ...,  # (3)
    ThemeArn: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> CreateAnalysisResponseTypeDef:  # (5)
    ...
  1. See AnalysisSourceEntityTypeDef
  2. See ParametersTypeDef
  3. See ResourcePermissionTypeDef
  4. See TagTypeDef
  5. See CreateAnalysisResponseTypeDef
Usage example with kwargs
kwargs: CreateAnalysisRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
    "Name": ...,
    "SourceEntity": ...,
}

parent.create_analysis(**kwargs)
  1. See CreateAnalysisRequestRequestTypeDef

create_dashboard

Creates a dashboard from a template.

Type annotations and code completion for boto3.client("quicksight").create_dashboard method. boto3 documentation

Method definition
def create_dashboard(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    Name: str,
    SourceEntity: DashboardSourceEntityTypeDef,  # (1)
    Parameters: ParametersTypeDef = ...,  # (2)
    Permissions: Sequence[ResourcePermissionTypeDef] = ...,  # (3)
    Tags: Sequence[TagTypeDef] = ...,  # (4)
    VersionDescription: str = ...,
    DashboardPublishOptions: DashboardPublishOptionsTypeDef = ...,  # (5)
    ThemeArn: str = ...,
) -> CreateDashboardResponseTypeDef:  # (6)
    ...
  1. See DashboardSourceEntityTypeDef
  2. See ParametersTypeDef
  3. See ResourcePermissionTypeDef
  4. See TagTypeDef
  5. See DashboardPublishOptionsTypeDef
  6. See CreateDashboardResponseTypeDef
Usage example with kwargs
kwargs: CreateDashboardRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
    "Name": ...,
    "SourceEntity": ...,
}

parent.create_dashboard(**kwargs)
  1. See CreateDashboardRequestRequestTypeDef

create_data_set

Creates a dataset.

Type annotations and code completion for boto3.client("quicksight").create_data_set method. boto3 documentation

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)
) -> CreateDataSetResponseTypeDef:  # (12)
    ...
  1. See PhysicalTableTypeDef
  2. See DataSetImportModeType
  3. See LogicalTableTypeDef
  4. See ColumnGroupTypeDef
  5. See FieldFolderTypeDef
  6. See ResourcePermissionTypeDef
  7. See RowLevelPermissionDataSetTypeDef
  8. See RowLevelPermissionTagConfigurationTypeDef
  9. See ColumnLevelPermissionRuleTypeDef
  10. See TagTypeDef
  11. See DataSetUsageConfigurationTypeDef
  12. See CreateDataSetResponseTypeDef
Usage example with kwargs
kwargs: CreateDataSetRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
    "Name": ...,
    "PhysicalTableMap": ...,
    "ImportMode": ...,
}

parent.create_data_set(**kwargs)
  1. See CreateDataSetRequestRequestTypeDef

create_data_source

Creates a data source.

Type annotations and code completion for boto3.client("quicksight").create_data_source method. boto3 documentation

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)
    ...
  1. See DataSourceTypeType
  2. See DataSourceParametersTypeDef
  3. See DataSourceCredentialsTypeDef
  4. See ResourcePermissionTypeDef
  5. See VpcConnectionPropertiesTypeDef
  6. See SslPropertiesTypeDef
  7. See TagTypeDef
  8. See CreateDataSourceResponseTypeDef
Usage example with kwargs
kwargs: CreateDataSourceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
    "Name": ...,
    "Type": ...,
}

parent.create_data_source(**kwargs)
  1. See CreateDataSourceRequestRequestTypeDef

create_folder

Creates an empty shared folder.

Type annotations and code completion for boto3.client("quicksight").create_folder method. boto3 documentation

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)
    ...
  1. See FolderTypeType
  2. See ResourcePermissionTypeDef
  3. See TagTypeDef
  4. See CreateFolderResponseTypeDef
Usage example with kwargs
kwargs: CreateFolderRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.create_folder(**kwargs)
  1. See CreateFolderRequestRequestTypeDef

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

Method definition
def create_folder_membership(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
    MemberId: str,
    MemberType: MemberTypeType,  # (1)
) -> CreateFolderMembershipResponseTypeDef:  # (2)
    ...
  1. See MemberTypeType
  2. See CreateFolderMembershipResponseTypeDef
Usage example with kwargs
kwargs: CreateFolderMembershipRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
    "MemberId": ...,
    "MemberType": ...,
}

parent.create_folder_membership(**kwargs)
  1. See CreateFolderMembershipRequestRequestTypeDef

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

Method definition
def create_group(
    self,
    *,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
    Description: str = ...,
) -> CreateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateGroupResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.create_group(**kwargs)
  1. See CreateGroupRequestRequestTypeDef

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

Method definition
def create_group_membership(
    self,
    *,
    MemberName: str,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
) -> CreateGroupMembershipResponseTypeDef:  # (1)
    ...
  1. See CreateGroupMembershipResponseTypeDef
Usage example with kwargs
kwargs: CreateGroupMembershipRequestRequestTypeDef = {  # (1)
    "MemberName": ...,
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.create_group_membership(**kwargs)
  1. See CreateGroupMembershipRequestRequestTypeDef

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

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)
    ...
  1. See AssignmentStatusType
  2. See CreateIAMPolicyAssignmentResponseTypeDef
Usage example with kwargs
kwargs: CreateIAMPolicyAssignmentRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AssignmentName": ...,
    "AssignmentStatus": ...,
    "Namespace": ...,
}

parent.create_iam_policy_assignment(**kwargs)
  1. See CreateIAMPolicyAssignmentRequestRequestTypeDef

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

Method definition
def create_ingestion(
    self,
    *,
    DataSetId: str,
    IngestionId: str,
    AwsAccountId: str,
    IngestionType: IngestionTypeType = ...,  # (1)
) -> CreateIngestionResponseTypeDef:  # (2)
    ...
  1. See IngestionTypeType
  2. See CreateIngestionResponseTypeDef
Usage example with kwargs
kwargs: CreateIngestionRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "IngestionId": ...,
    "AwsAccountId": ...,
}

parent.create_ingestion(**kwargs)
  1. See CreateIngestionRequestRequestTypeDef

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

Method definition
def create_namespace(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    IdentityStore: IdentityStoreType,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateNamespaceResponseTypeDef:  # (3)
    ...
  1. See IdentityStoreType
  2. See TagTypeDef
  3. See CreateNamespaceResponseTypeDef
Usage example with kwargs
kwargs: CreateNamespaceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
    "IdentityStore": ...,
}

parent.create_namespace(**kwargs)
  1. See CreateNamespaceRequestRequestTypeDef

create_template

Creates a template from an existing Amazon QuickSight analysis or template.

Type annotations and code completion for boto3.client("quicksight").create_template method. boto3 documentation

Method definition
def create_template(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    SourceEntity: TemplateSourceEntityTypeDef,  # (1)
    Name: str = ...,
    Permissions: Sequence[ResourcePermissionTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    VersionDescription: str = ...,
) -> CreateTemplateResponseTypeDef:  # (4)
    ...
  1. See TemplateSourceEntityTypeDef
  2. See ResourcePermissionTypeDef
  3. See TagTypeDef
  4. See CreateTemplateResponseTypeDef
Usage example with kwargs
kwargs: CreateTemplateRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "SourceEntity": ...,
}

parent.create_template(**kwargs)
  1. See CreateTemplateRequestRequestTypeDef

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

Method definition
def create_template_alias(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    AliasName: str,
    TemplateVersionNumber: int,
) -> CreateTemplateAliasResponseTypeDef:  # (1)
    ...
  1. See CreateTemplateAliasResponseTypeDef
Usage example with kwargs
kwargs: CreateTemplateAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "AliasName": ...,
    "TemplateVersionNumber": ...,
}

parent.create_template_alias(**kwargs)
  1. See CreateTemplateAliasRequestRequestTypeDef

create_theme

Creates a theme.

Type annotations and code completion for boto3.client("quicksight").create_theme method. boto3 documentation

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)
    ...
  1. See ThemeConfigurationTypeDef
  2. See ResourcePermissionTypeDef
  3. See TagTypeDef
  4. See CreateThemeResponseTypeDef
Usage example with kwargs
kwargs: CreateThemeRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "Name": ...,
    "BaseThemeId": ...,
    "Configuration": ...,
}

parent.create_theme(**kwargs)
  1. See CreateThemeRequestRequestTypeDef

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

Method definition
def create_theme_alias(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    AliasName: str,
    ThemeVersionNumber: int,
) -> CreateThemeAliasResponseTypeDef:  # (1)
    ...
  1. See CreateThemeAliasResponseTypeDef
Usage example with kwargs
kwargs: CreateThemeAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "AliasName": ...,
    "ThemeVersionNumber": ...,
}

parent.create_theme_alias(**kwargs)
  1. See CreateThemeAliasRequestRequestTypeDef

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

Method definition
def delete_account_customization(
    self,
    *,
    AwsAccountId: str,
    Namespace: str = ...,
) -> DeleteAccountCustomizationResponseTypeDef:  # (1)
    ...
  1. See DeleteAccountCustomizationResponseTypeDef
Usage example with kwargs
kwargs: DeleteAccountCustomizationRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.delete_account_customization(**kwargs)
  1. See DeleteAccountCustomizationRequestRequestTypeDef

delete_analysis

Deletes an analysis from Amazon QuickSight.

Type annotations and code completion for boto3.client("quicksight").delete_analysis method. boto3 documentation

Method definition
def delete_analysis(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
    RecoveryWindowInDays: int = ...,
    ForceDeleteWithoutRecovery: bool = ...,
) -> DeleteAnalysisResponseTypeDef:  # (1)
    ...
  1. See DeleteAnalysisResponseTypeDef
Usage example with kwargs
kwargs: DeleteAnalysisRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
}

parent.delete_analysis(**kwargs)
  1. See DeleteAnalysisRequestRequestTypeDef

delete_dashboard

Deletes a dashboard.

Type annotations and code completion for boto3.client("quicksight").delete_dashboard method. boto3 documentation

Method definition
def delete_dashboard(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    VersionNumber: int = ...,
) -> DeleteDashboardResponseTypeDef:  # (1)
    ...
  1. See DeleteDashboardResponseTypeDef
Usage example with kwargs
kwargs: DeleteDashboardRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
}

parent.delete_dashboard(**kwargs)
  1. See DeleteDashboardRequestRequestTypeDef

delete_data_set

Deletes a dataset.

Type annotations and code completion for boto3.client("quicksight").delete_data_set method. boto3 documentation

Method definition
def delete_data_set(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
) -> DeleteDataSetResponseTypeDef:  # (1)
    ...
  1. See DeleteDataSetResponseTypeDef
Usage example with kwargs
kwargs: DeleteDataSetRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
}

parent.delete_data_set(**kwargs)
  1. See DeleteDataSetRequestRequestTypeDef

delete_data_source

Deletes the data source permanently.

Type annotations and code completion for boto3.client("quicksight").delete_data_source method. boto3 documentation

Method definition
def delete_data_source(
    self,
    *,
    AwsAccountId: str,
    DataSourceId: str,
) -> DeleteDataSourceResponseTypeDef:  # (1)
    ...
  1. See DeleteDataSourceResponseTypeDef
Usage example with kwargs
kwargs: DeleteDataSourceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
}

parent.delete_data_source(**kwargs)
  1. See DeleteDataSourceRequestRequestTypeDef

delete_folder

Deletes an empty folder.

Type annotations and code completion for boto3.client("quicksight").delete_folder method. boto3 documentation

Method definition
def delete_folder(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
) -> DeleteFolderResponseTypeDef:  # (1)
    ...
  1. See DeleteFolderResponseTypeDef
Usage example with kwargs
kwargs: DeleteFolderRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.delete_folder(**kwargs)
  1. See DeleteFolderRequestRequestTypeDef

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

Method definition
def delete_folder_membership(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
    MemberId: str,
    MemberType: MemberTypeType,  # (1)
) -> DeleteFolderMembershipResponseTypeDef:  # (2)
    ...
  1. See MemberTypeType
  2. See DeleteFolderMembershipResponseTypeDef
Usage example with kwargs
kwargs: DeleteFolderMembershipRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
    "MemberId": ...,
    "MemberType": ...,
}

parent.delete_folder_membership(**kwargs)
  1. See DeleteFolderMembershipRequestRequestTypeDef

delete_group

Removes a user group from Amazon QuickSight.

Type annotations and code completion for boto3.client("quicksight").delete_group method. boto3 documentation

Method definition
def delete_group(
    self,
    *,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DeleteGroupResponseTypeDef:  # (1)
    ...
  1. See DeleteGroupResponseTypeDef
Usage example with kwargs
kwargs: DeleteGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.delete_group(**kwargs)
  1. See DeleteGroupRequestRequestTypeDef

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

Method definition
def delete_group_membership(
    self,
    *,
    MemberName: str,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DeleteGroupMembershipResponseTypeDef:  # (1)
    ...
  1. See DeleteGroupMembershipResponseTypeDef
Usage example with kwargs
kwargs: DeleteGroupMembershipRequestRequestTypeDef = {  # (1)
    "MemberName": ...,
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.delete_group_membership(**kwargs)
  1. See DeleteGroupMembershipRequestRequestTypeDef

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

Method definition
def delete_iam_policy_assignment(
    self,
    *,
    AwsAccountId: str,
    AssignmentName: str,
    Namespace: str,
) -> DeleteIAMPolicyAssignmentResponseTypeDef:  # (1)
    ...
  1. See DeleteIAMPolicyAssignmentResponseTypeDef
Usage example with kwargs
kwargs: DeleteIAMPolicyAssignmentRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AssignmentName": ...,
    "Namespace": ...,
}

parent.delete_iam_policy_assignment(**kwargs)
  1. See DeleteIAMPolicyAssignmentRequestRequestTypeDef

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

Method definition
def delete_namespace(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
) -> DeleteNamespaceResponseTypeDef:  # (1)
    ...
  1. See DeleteNamespaceResponseTypeDef
Usage example with kwargs
kwargs: DeleteNamespaceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.delete_namespace(**kwargs)
  1. See DeleteNamespaceRequestRequestTypeDef

delete_template

Deletes a template.

Type annotations and code completion for boto3.client("quicksight").delete_template method. boto3 documentation

Method definition
def delete_template(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    VersionNumber: int = ...,
) -> DeleteTemplateResponseTypeDef:  # (1)
    ...
  1. See DeleteTemplateResponseTypeDef
Usage example with kwargs
kwargs: DeleteTemplateRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.delete_template(**kwargs)
  1. See DeleteTemplateRequestRequestTypeDef

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

Method definition
def delete_template_alias(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    AliasName: str,
) -> DeleteTemplateAliasResponseTypeDef:  # (1)
    ...
  1. See DeleteTemplateAliasResponseTypeDef
Usage example with kwargs
kwargs: DeleteTemplateAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "AliasName": ...,
}

parent.delete_template_alias(**kwargs)
  1. See DeleteTemplateAliasRequestRequestTypeDef

delete_theme

Deletes a theme.

Type annotations and code completion for boto3.client("quicksight").delete_theme method. boto3 documentation

Method definition
def delete_theme(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    VersionNumber: int = ...,
) -> DeleteThemeResponseTypeDef:  # (1)
    ...
  1. See DeleteThemeResponseTypeDef
Usage example with kwargs
kwargs: DeleteThemeRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.delete_theme(**kwargs)
  1. See DeleteThemeRequestRequestTypeDef

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

Method definition
def delete_theme_alias(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    AliasName: str,
) -> DeleteThemeAliasResponseTypeDef:  # (1)
    ...
  1. See DeleteThemeAliasResponseTypeDef
Usage example with kwargs
kwargs: DeleteThemeAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "AliasName": ...,
}

parent.delete_theme_alias(**kwargs)
  1. See DeleteThemeAliasRequestRequestTypeDef

delete_user

Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call.

Type annotations and code completion for boto3.client("quicksight").delete_user method. boto3 documentation

Method definition
def delete_user(
    self,
    *,
    UserName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DeleteUserResponseTypeDef:  # (1)
    ...
  1. See DeleteUserResponseTypeDef
Usage example with kwargs
kwargs: DeleteUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.delete_user(**kwargs)
  1. See DeleteUserRequestRequestTypeDef

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

Method definition
def delete_user_by_principal_id(
    self,
    *,
    PrincipalId: str,
    AwsAccountId: str,
    Namespace: str,
) -> DeleteUserByPrincipalIdResponseTypeDef:  # (1)
    ...
  1. See DeleteUserByPrincipalIdResponseTypeDef
Usage example with kwargs
kwargs: DeleteUserByPrincipalIdRequestRequestTypeDef = {  # (1)
    "PrincipalId": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.delete_user_by_principal_id(**kwargs)
  1. See DeleteUserByPrincipalIdRequestRequestTypeDef

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

Method definition
def describe_account_customization(
    self,
    *,
    AwsAccountId: str,
    Namespace: str = ...,
    Resolved: bool = ...,
) -> DescribeAccountCustomizationResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountCustomizationResponseTypeDef
Usage example with kwargs
kwargs: DescribeAccountCustomizationRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.describe_account_customization(**kwargs)
  1. See DescribeAccountCustomizationRequestRequestTypeDef

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

Method definition
def describe_account_settings(
    self,
    *,
    AwsAccountId: str,
) -> DescribeAccountSettingsResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountSettingsResponseTypeDef
Usage example with kwargs
kwargs: DescribeAccountSettingsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.describe_account_settings(**kwargs)
  1. See DescribeAccountSettingsRequestRequestTypeDef

describe_account_subscription

Use the DescribeAccountSubscription operation to receive a description of a Amazon QuickSight account's subscription.

Type annotations and code completion for boto3.client("quicksight").describe_account_subscription method. boto3 documentation

Method definition
def describe_account_subscription(
    self,
    *,
    AwsAccountId: str,
) -> DescribeAccountSubscriptionResponseTypeDef:  # (1)
    ...
  1. See DescribeAccountSubscriptionResponseTypeDef
Usage example with kwargs
kwargs: DescribeAccountSubscriptionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.describe_account_subscription(**kwargs)
  1. See DescribeAccountSubscriptionRequestRequestTypeDef

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

Method definition
def describe_analysis(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
) -> DescribeAnalysisResponseTypeDef:  # (1)
    ...
  1. See DescribeAnalysisResponseTypeDef
Usage example with kwargs
kwargs: DescribeAnalysisRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
}

parent.describe_analysis(**kwargs)
  1. See DescribeAnalysisRequestRequestTypeDef

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

Method definition
def describe_analysis_permissions(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
) -> DescribeAnalysisPermissionsResponseTypeDef:  # (1)
    ...
  1. See DescribeAnalysisPermissionsResponseTypeDef
Usage example with kwargs
kwargs: DescribeAnalysisPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
}

parent.describe_analysis_permissions(**kwargs)
  1. See DescribeAnalysisPermissionsRequestRequestTypeDef

describe_dashboard

Provides a summary for a dashboard.

Type annotations and code completion for boto3.client("quicksight").describe_dashboard method. boto3 documentation

Method definition
def describe_dashboard(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    VersionNumber: int = ...,
    AliasName: str = ...,
) -> DescribeDashboardResponseTypeDef:  # (1)
    ...
  1. See DescribeDashboardResponseTypeDef
Usage example with kwargs
kwargs: DescribeDashboardRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
}

parent.describe_dashboard(**kwargs)
  1. See DescribeDashboardRequestRequestTypeDef

describe_dashboard_permissions

Describes read and write permissions for a dashboard.

Type annotations and code completion for boto3.client("quicksight").describe_dashboard_permissions method. boto3 documentation

Method definition
def describe_dashboard_permissions(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
) -> DescribeDashboardPermissionsResponseTypeDef:  # (1)
    ...
  1. See DescribeDashboardPermissionsResponseTypeDef
Usage example with kwargs
kwargs: DescribeDashboardPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
}

parent.describe_dashboard_permissions(**kwargs)
  1. See DescribeDashboardPermissionsRequestRequestTypeDef

describe_data_set

Describes a dataset.

Type annotations and code completion for boto3.client("quicksight").describe_data_set method. boto3 documentation

Method definition
def describe_data_set(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
) -> DescribeDataSetResponseTypeDef:  # (1)
    ...
  1. See DescribeDataSetResponseTypeDef
Usage example with kwargs
kwargs: DescribeDataSetRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
}

parent.describe_data_set(**kwargs)
  1. See DescribeDataSetRequestRequestTypeDef

describe_data_set_permissions

Describes the permissions on a dataset.

Type annotations and code completion for boto3.client("quicksight").describe_data_set_permissions method. boto3 documentation

Method definition
def describe_data_set_permissions(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
) -> DescribeDataSetPermissionsResponseTypeDef:  # (1)
    ...
  1. See DescribeDataSetPermissionsResponseTypeDef
Usage example with kwargs
kwargs