QuickSightClient

Index > QuickSight > QuickSightClient

Auto-generated documentation for QuickSight type annotations stubs module types-aiobotocore-quicksight.

QuickSightClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_quicksight.client import QuickSightClient

session = Session()
async with session.client("quicksight") as client:
    client: QuickSightClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("quicksight").exceptions structure.

Usage example

async with session.client("quicksight") as client:
    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 types_aiobotocore_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 session.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 session.client("quicksight").cancel_ingestion method. boto3 documentation

Method definition

await 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 session.client("quicksight").close method. boto3 documentation

Method definition

await def close(
    self,
) -> None:
    ...

create_account_customization

Creates Amazon QuickSight customizations for the current Amazon Web Services Region.

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

Method definition

await 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 session.client("quicksight").create_account_subscription method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_analysis method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_dashboard method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_data_set method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_data_source method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_folder method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_folder_membership method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_group method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_group_membership method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_iam_policy_assignment method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_ingestion method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_namespace method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_template method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_template_alias method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_theme method. boto3 documentation

Method definition

await 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 session.client("quicksight").create_theme_alias method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_account_customization method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_analysis method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_dashboard method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_data_set method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_data_source method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_folder method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_folder_membership method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_group method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_group_membership method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_iam_policy_assignment method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_namespace method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_template method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_template_alias method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_theme method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_theme_alias method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_user method. boto3 documentation

Method definition

await 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 session.client("quicksight").delete_user_by_principal_id method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_account_customization method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_account_settings method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_account_subscription method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_analysis method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_analysis_permissions method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_dashboard method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_dashboard_permissions method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_data_set method. boto3 documentation

Method definition

await 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 session.client("quicksight").describe_data_set_permissions method. boto3 documentation

Method definition

await def describe_data_set_permissions(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
) -> DescribeDataSetPermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeDataSetPermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeDataSetPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
}

parent.describe_data_set_permissions(**kwargs)

1. See DescribeDataSetPermissionsRequestRequestTypeDef

describe_data_source

Describes a data source.

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

Method definition

await def describe_data_source(
    self,
    *,
    AwsAccountId: str,
    DataSourceId: str,
) -> DescribeDataSourceResponseTypeDef:  # (1)
    ...

1. See DescribeDataSourceResponseTypeDef

Usage example with kwargs

kwargs: DescribeDataSourceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
}

parent.describe_data_source(**kwargs)

1. See DescribeDataSourceRequestRequestTypeDef

describe_data_source_permissions

Describes the resource permissions for a data source.

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

Method definition

await def describe_data_source_permissions(
    self,
    *,
    AwsAccountId: str,
    DataSourceId: str,
) -> DescribeDataSourcePermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeDataSourcePermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeDataSourcePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
}

parent.describe_data_source_permissions(**kwargs)

1. See DescribeDataSourcePermissionsRequestRequestTypeDef

describe_folder

Describes a folder.

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

Method definition

await def describe_folder(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
) -> DescribeFolderResponseTypeDef:  # (1)
    ...

1. See DescribeFolderResponseTypeDef

Usage example with kwargs

kwargs: DescribeFolderRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.describe_folder(**kwargs)

1. See DescribeFolderRequestRequestTypeDef

describe_folder_permissions

Describes permissions for a folder.

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

Method definition

await def describe_folder_permissions(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
) -> DescribeFolderPermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeFolderPermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeFolderPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.describe_folder_permissions(**kwargs)

1. See DescribeFolderPermissionsRequestRequestTypeDef

describe_folder_resolved_permissions

Describes the folder resolved permissions.

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

Method definition

await def describe_folder_resolved_permissions(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
) -> DescribeFolderResolvedPermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeFolderResolvedPermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeFolderResolvedPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.describe_folder_resolved_permissions(**kwargs)

1. See DescribeFolderResolvedPermissionsRequestRequestTypeDef

describe_group

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

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

Method definition

await def describe_group(
    self,
    *,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DescribeGroupResponseTypeDef:  # (1)
    ...

1. See DescribeGroupResponseTypeDef

Usage example with kwargs

kwargs: DescribeGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.describe_group(**kwargs)

1. See DescribeGroupRequestRequestTypeDef

describe_group_membership

Use the DescribeGroupMembership operation to determine if a user is a member of the specified group.

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

Method definition

await def describe_group_membership(
    self,
    *,
    MemberName: str,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DescribeGroupMembershipResponseTypeDef:  # (1)
    ...

1. See DescribeGroupMembershipResponseTypeDef

Usage example with kwargs

kwargs: DescribeGroupMembershipRequestRequestTypeDef = {  # (1)
    "MemberName": ...,
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.describe_group_membership(**kwargs)

1. See DescribeGroupMembershipRequestRequestTypeDef

describe_iam_policy_assignment

Describes an existing IAM policy assignment, as specified by the assignment name.

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

Method definition

await def describe_iam_policy_assignment(
    self,
    *,
    AwsAccountId: str,
    AssignmentName: str,
    Namespace: str,
) -> DescribeIAMPolicyAssignmentResponseTypeDef:  # (1)
    ...

1. See DescribeIAMPolicyAssignmentResponseTypeDef

Usage example with kwargs

kwargs: DescribeIAMPolicyAssignmentRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AssignmentName": ...,
    "Namespace": ...,
}

parent.describe_iam_policy_assignment(**kwargs)

1. See DescribeIAMPolicyAssignmentRequestRequestTypeDef

describe_ingestion

Describes a SPICE ingestion.

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

Method definition

await def describe_ingestion(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
    IngestionId: str,
) -> DescribeIngestionResponseTypeDef:  # (1)
    ...

1. See DescribeIngestionResponseTypeDef

Usage example with kwargs

kwargs: DescribeIngestionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
    "IngestionId": ...,
}

parent.describe_ingestion(**kwargs)

1. See DescribeIngestionRequestRequestTypeDef

describe_ip_restriction

Provides a summary and status of IP rules.

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

Method definition

await def describe_ip_restriction(
    self,
    *,
    AwsAccountId: str,
) -> DescribeIpRestrictionResponseTypeDef:  # (1)
    ...

1. See DescribeIpRestrictionResponseTypeDef

Usage example with kwargs

kwargs: DescribeIpRestrictionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.describe_ip_restriction(**kwargs)

1. See DescribeIpRestrictionRequestRequestTypeDef

describe_namespace

Describes the current namespace.

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

Method definition

await def describe_namespace(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
) -> DescribeNamespaceResponseTypeDef:  # (1)
    ...

1. See DescribeNamespaceResponseTypeDef

Usage example with kwargs

kwargs: DescribeNamespaceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.describe_namespace(**kwargs)

1. See DescribeNamespaceRequestRequestTypeDef

describe_template

Describes a template's metadata.

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

Method definition

await def describe_template(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    VersionNumber: int = ...,
    AliasName: str = ...,
) -> DescribeTemplateResponseTypeDef:  # (1)
    ...

1. See DescribeTemplateResponseTypeDef

Usage example with kwargs

kwargs: DescribeTemplateRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.describe_template(**kwargs)

1. See DescribeTemplateRequestRequestTypeDef

describe_template_alias

Describes the template alias for a template.

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

Method definition

await def describe_template_alias(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    AliasName: str,
) -> DescribeTemplateAliasResponseTypeDef:  # (1)
    ...

1. See DescribeTemplateAliasResponseTypeDef

Usage example with kwargs

kwargs: DescribeTemplateAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "AliasName": ...,
}

parent.describe_template_alias(**kwargs)

1. See DescribeTemplateAliasRequestRequestTypeDef

describe_template_permissions

Describes read and write permissions on a template.

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

Method definition

await def describe_template_permissions(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
) -> DescribeTemplatePermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeTemplatePermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeTemplatePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.describe_template_permissions(**kwargs)

1. See DescribeTemplatePermissionsRequestRequestTypeDef

describe_theme

Describes a theme.

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

Method definition

await def describe_theme(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    VersionNumber: int = ...,
    AliasName: str = ...,
) -> DescribeThemeResponseTypeDef:  # (1)
    ...

1. See DescribeThemeResponseTypeDef

Usage example with kwargs

kwargs: DescribeThemeRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.describe_theme(**kwargs)

1. See DescribeThemeRequestRequestTypeDef

describe_theme_alias

Describes the alias for a theme.

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

Method definition

await def describe_theme_alias(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    AliasName: str,
) -> DescribeThemeAliasResponseTypeDef:  # (1)
    ...

1. See DescribeThemeAliasResponseTypeDef

Usage example with kwargs

kwargs: DescribeThemeAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "AliasName": ...,
}

parent.describe_theme_alias(**kwargs)

1. See DescribeThemeAliasRequestRequestTypeDef

describe_theme_permissions

Describes the read and write permissions for a theme.

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

Method definition

await def describe_theme_permissions(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
) -> DescribeThemePermissionsResponseTypeDef:  # (1)
    ...

1. See DescribeThemePermissionsResponseTypeDef

Usage example with kwargs

kwargs: DescribeThemePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.describe_theme_permissions(**kwargs)

1. See DescribeThemePermissionsRequestRequestTypeDef

describe_user

Returns information about a user, given the user name.

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

Method definition

await def describe_user(
    self,
    *,
    UserName: str,
    AwsAccountId: str,
    Namespace: str,
) -> DescribeUserResponseTypeDef:  # (1)
    ...

1. See DescribeUserResponseTypeDef

Usage example with kwargs

kwargs: DescribeUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.describe_user(**kwargs)

1. See DescribeUserRequestRequestTypeDef

generate_embed_url_for_anonymous_user

Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users.

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

Method definition

await def generate_embed_url_for_anonymous_user(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    AuthorizedResourceArns: Sequence[str],
    ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfigurationTypeDef,  # (1)
    SessionLifetimeInMinutes: int = ...,
    SessionTags: Sequence[SessionTagTypeDef] = ...,  # (2)
    AllowedDomains: Sequence[str] = ...,
) -> GenerateEmbedUrlForAnonymousUserResponseTypeDef:  # (3)
    ...

1. See AnonymousUserEmbeddingExperienceConfigurationTypeDef
2. See SessionTagTypeDef
3. See GenerateEmbedUrlForAnonymousUserResponseTypeDef

Usage example with kwargs

kwargs: GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
    "AuthorizedResourceArns": ...,
    "ExperienceConfiguration": ...,
}

parent.generate_embed_url_for_anonymous_user(**kwargs)

1. See GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef

generate_embed_url_for_registered_user

Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website.

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

Method definition

await def generate_embed_url_for_registered_user(
    self,
    *,
    AwsAccountId: str,
    UserArn: str,
    ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfigurationTypeDef,  # (1)
    SessionLifetimeInMinutes: int = ...,
    AllowedDomains: Sequence[str] = ...,
) -> GenerateEmbedUrlForRegisteredUserResponseTypeDef:  # (2)
    ...

1. See RegisteredUserEmbeddingExperienceConfigurationTypeDef
2. See GenerateEmbedUrlForRegisteredUserResponseTypeDef

Usage example with kwargs

kwargs: GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "UserArn": ...,
    "ExperienceConfiguration": ...,
}

parent.generate_embed_url_for_registered_user(**kwargs)

1. See GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

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

Method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_dashboard_embed_url

Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application.

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

Method definition

await def get_dashboard_embed_url(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    IdentityType: EmbeddingIdentityTypeType,  # (1)
    SessionLifetimeInMinutes: int = ...,
    UndoRedoDisabled: bool = ...,
    ResetDisabled: bool = ...,
    StatePersistenceEnabled: bool = ...,
    UserArn: str = ...,
    Namespace: str = ...,
    AdditionalDashboardIds: Sequence[str] = ...,
) -> GetDashboardEmbedUrlResponseTypeDef:  # (2)
    ...

1. See EmbeddingIdentityTypeType
2. See GetDashboardEmbedUrlResponseTypeDef

Usage example with kwargs

kwargs: GetDashboardEmbedUrlRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
    "IdentityType": ...,
}

parent.get_dashboard_embed_url(**kwargs)

1. See GetDashboardEmbedUrlRequestRequestTypeDef

get_session_embed_url

Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code.

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

Method definition

await def get_session_embed_url(
    self,
    *,
    AwsAccountId: str,
    EntryPoint: str = ...,
    SessionLifetimeInMinutes: int = ...,
    UserArn: str = ...,
) -> GetSessionEmbedUrlResponseTypeDef:  # (1)
    ...

1. See GetSessionEmbedUrlResponseTypeDef

Usage example with kwargs

kwargs: GetSessionEmbedUrlRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.get_session_embed_url(**kwargs)

1. See GetSessionEmbedUrlRequestRequestTypeDef

list_analyses

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

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

Method definition

await def list_analyses(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAnalysesResponseTypeDef:  # (1)
    ...

1. See ListAnalysesResponseTypeDef

Usage example with kwargs

kwargs: ListAnalysesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_analyses(**kwargs)

1. See ListAnalysesRequestRequestTypeDef

list_dashboard_versions

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

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

Method definition

await def list_dashboard_versions(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDashboardVersionsResponseTypeDef:  # (1)
    ...

1. See ListDashboardVersionsResponseTypeDef

Usage example with kwargs

kwargs: ListDashboardVersionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
}

parent.list_dashboard_versions(**kwargs)

1. See ListDashboardVersionsRequestRequestTypeDef

list_dashboards

Lists dashboards in an Amazon Web Services account.

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

Method definition

await def list_dashboards(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDashboardsResponseTypeDef:  # (1)
    ...

1. See ListDashboardsResponseTypeDef

Usage example with kwargs

kwargs: ListDashboardsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_dashboards(**kwargs)

1. See ListDashboardsRequestRequestTypeDef

list_data_sets

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

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

Method definition

await def list_data_sets(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataSetsResponseTypeDef:  # (1)
    ...

1. See ListDataSetsResponseTypeDef

Usage example with kwargs

kwargs: ListDataSetsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_data_sets(**kwargs)

1. See ListDataSetsRequestRequestTypeDef

list_data_sources

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

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

Method definition

await def list_data_sources(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef:  # (1)
    ...

1. See ListDataSourcesResponseTypeDef

Usage example with kwargs

kwargs: ListDataSourcesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_data_sources(**kwargs)

1. See ListDataSourcesRequestRequestTypeDef

list_folder_members

List all assets (DASHBOARD , ANALYSIS , and DATASET ) in a folder.

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

Method definition

await def list_folder_members(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFolderMembersResponseTypeDef:  # (1)
    ...

1. See ListFolderMembersResponseTypeDef

Usage example with kwargs

kwargs: ListFolderMembersRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.list_folder_members(**kwargs)

1. See ListFolderMembersRequestRequestTypeDef

list_folders

Lists all folders in an account.

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

Method definition

await def list_folders(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListFoldersResponseTypeDef:  # (1)
    ...

1. See ListFoldersResponseTypeDef

Usage example with kwargs

kwargs: ListFoldersRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_folders(**kwargs)

1. See ListFoldersRequestRequestTypeDef

list_group_memberships

Lists member users in a group.

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

Method definition

await def list_group_memberships(
    self,
    *,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupMembershipsResponseTypeDef:  # (1)
    ...

1. See ListGroupMembershipsResponseTypeDef

Usage example with kwargs

kwargs: ListGroupMembershipsRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.list_group_memberships(**kwargs)

1. See ListGroupMembershipsRequestRequestTypeDef

list_groups

Lists all user groups in Amazon QuickSight.

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

Method definition

await def list_groups(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListGroupsResponseTypeDef:  # (1)
    ...

1. See ListGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListGroupsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.list_groups(**kwargs)

1. See ListGroupsRequestRequestTypeDef

list_iam_policy_assignments

Lists IAM policy assignments in the current Amazon QuickSight account.

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

Method definition

await def list_iam_policy_assignments(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    AssignmentStatus: AssignmentStatusType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsResponseTypeDef:  # (2)
    ...

1. See AssignmentStatusType
2. See ListIAMPolicyAssignmentsResponseTypeDef

Usage example with kwargs

kwargs: ListIAMPolicyAssignmentsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.list_iam_policy_assignments(**kwargs)

1. See ListIAMPolicyAssignmentsRequestRequestTypeDef

list_iam_policy_assignments_for_user

Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.

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

Method definition

await def list_iam_policy_assignments_for_user(
    self,
    *,
    AwsAccountId: str,
    UserName: str,
    Namespace: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsForUserResponseTypeDef:  # (1)
    ...

1. See ListIAMPolicyAssignmentsForUserResponseTypeDef

Usage example with kwargs

kwargs: ListIAMPolicyAssignmentsForUserRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "UserName": ...,
    "Namespace": ...,
}

parent.list_iam_policy_assignments_for_user(**kwargs)

1. See ListIAMPolicyAssignmentsForUserRequestRequestTypeDef

list_ingestions

Lists the history of SPICE ingestions for a dataset.

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

Method definition

await def list_ingestions(
    self,
    *,
    DataSetId: str,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListIngestionsResponseTypeDef:  # (1)
    ...

1. See ListIngestionsResponseTypeDef

Usage example with kwargs

kwargs: ListIngestionsRequestRequestTypeDef = {  # (1)
    "DataSetId": ...,
    "AwsAccountId": ...,
}

parent.list_ingestions(**kwargs)

1. See ListIngestionsRequestRequestTypeDef

list_namespaces

Lists the namespaces for the specified Amazon Web Services account.

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

Method definition

await def list_namespaces(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListNamespacesResponseTypeDef:  # (1)
    ...

1. See ListNamespacesResponseTypeDef

Usage example with kwargs

kwargs: ListNamespacesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_namespaces(**kwargs)

1. See ListNamespacesRequestRequestTypeDef

list_tags_for_resource

Lists the tags assigned to a resource.

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

Method definition

await def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_template_aliases

Lists all the aliases of a template.

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

Method definition

await def list_template_aliases(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTemplateAliasesResponseTypeDef:  # (1)
    ...

1. See ListTemplateAliasesResponseTypeDef

Usage example with kwargs

kwargs: ListTemplateAliasesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.list_template_aliases(**kwargs)

1. See ListTemplateAliasesRequestRequestTypeDef

list_template_versions

Lists all the versions of the templates in the current Amazon QuickSight account.

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

Method definition

await def list_template_versions(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTemplateVersionsResponseTypeDef:  # (1)
    ...

1. See ListTemplateVersionsResponseTypeDef

Usage example with kwargs

kwargs: ListTemplateVersionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.list_template_versions(**kwargs)

1. See ListTemplateVersionsRequestRequestTypeDef

list_templates

Lists all the templates in the current Amazon QuickSight account.

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

Method definition

await def list_templates(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListTemplatesResponseTypeDef:  # (1)
    ...

1. See ListTemplatesResponseTypeDef

Usage example with kwargs

kwargs: ListTemplatesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_templates(**kwargs)

1. See ListTemplatesRequestRequestTypeDef

list_theme_aliases

Lists all the aliases of a theme.

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

Method definition

await def list_theme_aliases(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListThemeAliasesResponseTypeDef:  # (1)
    ...

1. See ListThemeAliasesResponseTypeDef

Usage example with kwargs

kwargs: ListThemeAliasesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.list_theme_aliases(**kwargs)

1. See ListThemeAliasesRequestRequestTypeDef

list_theme_versions

Lists all the versions of the themes in the current Amazon Web Services account.

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

Method definition

await def list_theme_versions(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListThemeVersionsResponseTypeDef:  # (1)
    ...

1. See ListThemeVersionsResponseTypeDef

Usage example with kwargs

kwargs: ListThemeVersionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.list_theme_versions(**kwargs)

1. See ListThemeVersionsRequestRequestTypeDef

list_themes

Lists all the themes in the current Amazon Web Services account.

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

Method definition

await def list_themes(
    self,
    *,
    AwsAccountId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    Type: ThemeTypeType = ...,  # (1)
) -> ListThemesResponseTypeDef:  # (2)
    ...

1. See ThemeTypeType
2. See ListThemesResponseTypeDef

Usage example with kwargs

kwargs: ListThemesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.list_themes(**kwargs)

1. See ListThemesRequestRequestTypeDef

list_user_groups

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

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

Method definition

await def list_user_groups(
    self,
    *,
    UserName: str,
    AwsAccountId: str,
    Namespace: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUserGroupsResponseTypeDef:  # (1)
    ...

1. See ListUserGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListUserGroupsRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.list_user_groups(**kwargs)

1. See ListUserGroupsRequestRequestTypeDef

list_users

Returns a list of all of the Amazon QuickSight users belonging to this account.

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

Method definition

await def list_users(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...

1. See ListUsersResponseTypeDef

Usage example with kwargs

kwargs: ListUsersRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestRequestTypeDef

register_user

.

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

Method definition

await def register_user(
    self,
    *,
    IdentityType: IdentityTypeType,  # (1)
    Email: str,
    UserRole: UserRoleType,  # (2)
    AwsAccountId: str,
    Namespace: str,
    IamArn: str = ...,
    SessionName: str = ...,
    UserName: str = ...,
    CustomPermissionsName: str = ...,
    ExternalLoginFederationProviderType: str = ...,
    CustomFederationProviderUrl: str = ...,
    ExternalLoginId: str = ...,
) -> RegisterUserResponseTypeDef:  # (3)
    ...

1. See IdentityTypeType
2. See UserRoleType
3. See RegisterUserResponseTypeDef

Usage example with kwargs

kwargs: RegisterUserRequestRequestTypeDef = {  # (1)
    "IdentityType": ...,
    "Email": ...,
    "UserRole": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.register_user(**kwargs)

1. See RegisterUserRequestRequestTypeDef

restore_analysis

Restores an analysis.

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

Method definition

await def restore_analysis(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
) -> RestoreAnalysisResponseTypeDef:  # (1)
    ...

1. See RestoreAnalysisResponseTypeDef

Usage example with kwargs

kwargs: RestoreAnalysisRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
}

parent.restore_analysis(**kwargs)

1. See RestoreAnalysisRequestRequestTypeDef

search_analyses

Searches for analyses that belong to the user specified in the filter.

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

Method definition

await def search_analyses(
    self,
    *,
    AwsAccountId: str,
    Filters: Sequence[AnalysisSearchFilterTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchAnalysesResponseTypeDef:  # (2)
    ...

1. See AnalysisSearchFilterTypeDef
2. See SearchAnalysesResponseTypeDef

Usage example with kwargs

kwargs: SearchAnalysesRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Filters": ...,
}

parent.search_analyses(**kwargs)

1. See SearchAnalysesRequestRequestTypeDef

search_dashboards

Searches for dashboards that belong to a user.

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

Method definition

await def search_dashboards(
    self,
    *,
    AwsAccountId: str,
    Filters: Sequence[DashboardSearchFilterTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchDashboardsResponseTypeDef:  # (2)
    ...

1. See DashboardSearchFilterTypeDef
2. See SearchDashboardsResponseTypeDef

Usage example with kwargs

kwargs: SearchDashboardsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Filters": ...,
}

parent.search_dashboards(**kwargs)

1. See SearchDashboardsRequestRequestTypeDef

search_folders

Searches the subfolders in a folder.

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

Method definition

await def search_folders(
    self,
    *,
    AwsAccountId: str,
    Filters: Sequence[FolderSearchFilterTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchFoldersResponseTypeDef:  # (2)
    ...

1. See FolderSearchFilterTypeDef
2. See SearchFoldersResponseTypeDef

Usage example with kwargs

kwargs: SearchFoldersRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Filters": ...,
}

parent.search_folders(**kwargs)

1. See SearchFoldersRequestRequestTypeDef

search_groups

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

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

Method definition

await def search_groups(
    self,
    *,
    AwsAccountId: str,
    Namespace: str,
    Filters: Sequence[GroupSearchFilterTypeDef],  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> SearchGroupsResponseTypeDef:  # (2)
    ...

1. See GroupSearchFilterTypeDef
2. See SearchGroupsResponseTypeDef

Usage example with kwargs

kwargs: SearchGroupsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "Namespace": ...,
    "Filters": ...,
}

parent.search_groups(**kwargs)

1. See SearchGroupsRequestRequestTypeDef

tag_resource

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

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

Method definition

await def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> TagResourceResponseTypeDef:  # (2)
    ...

1. See TagTypeDef
2. See TagResourceResponseTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag or tags from a resource.

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

Method definition

await def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> UntagResourceResponseTypeDef:  # (1)
    ...

1. See UntagResourceResponseTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_account_customization

Updates Amazon QuickSight customizations for the current Amazon Web Services Region.

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

Method definition

await def update_account_customization(
    self,
    *,
    AwsAccountId: str,
    AccountCustomization: AccountCustomizationTypeDef,  # (1)
    Namespace: str = ...,
) -> UpdateAccountCustomizationResponseTypeDef:  # (2)
    ...

1. See AccountCustomizationTypeDef
2. See UpdateAccountCustomizationResponseTypeDef

Usage example with kwargs

kwargs: UpdateAccountCustomizationRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AccountCustomization": ...,
}

parent.update_account_customization(**kwargs)

1. See UpdateAccountCustomizationRequestRequestTypeDef

update_account_settings

Updates the Amazon QuickSight settings in your Amazon Web Services account.

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

Method definition

await def update_account_settings(
    self,
    *,
    AwsAccountId: str,
    DefaultNamespace: str,
    NotificationEmail: str = ...,
) -> UpdateAccountSettingsResponseTypeDef:  # (1)
    ...

1. See UpdateAccountSettingsResponseTypeDef

Usage example with kwargs

kwargs: UpdateAccountSettingsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DefaultNamespace": ...,
}

parent.update_account_settings(**kwargs)

1. See UpdateAccountSettingsRequestRequestTypeDef

update_analysis

Updates an analysis in Amazon QuickSight See also: AWS API Documentation.

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

Method definition

await def update_analysis(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
    Name: str,
    SourceEntity: AnalysisSourceEntityTypeDef,  # (1)
    Parameters: ParametersTypeDef = ...,  # (2)
    ThemeArn: str = ...,
) -> UpdateAnalysisResponseTypeDef:  # (3)
    ...

1. See AnalysisSourceEntityTypeDef
2. See ParametersTypeDef
3. See UpdateAnalysisResponseTypeDef

Usage example with kwargs

kwargs: UpdateAnalysisRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
    "Name": ...,
    "SourceEntity": ...,
}

parent.update_analysis(**kwargs)

1. See UpdateAnalysisRequestRequestTypeDef

update_analysis_permissions

Updates the read and write permissions for an analysis.

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

Method definition

await def update_analysis_permissions(
    self,
    *,
    AwsAccountId: str,
    AnalysisId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateAnalysisPermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateAnalysisPermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateAnalysisPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AnalysisId": ...,
}

parent.update_analysis_permissions(**kwargs)

1. See UpdateAnalysisPermissionsRequestRequestTypeDef

update_dashboard

Updates a dashboard in an Amazon Web Services account.

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

Method definition

await def update_dashboard(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    Name: str,
    SourceEntity: DashboardSourceEntityTypeDef,  # (1)
    Parameters: ParametersTypeDef = ...,  # (2)
    VersionDescription: str = ...,
    DashboardPublishOptions: DashboardPublishOptionsTypeDef = ...,  # (3)
    ThemeArn: str = ...,
) -> UpdateDashboardResponseTypeDef:  # (4)
    ...

1. See DashboardSourceEntityTypeDef
2. See ParametersTypeDef
3. See DashboardPublishOptionsTypeDef
4. See UpdateDashboardResponseTypeDef

Usage example with kwargs

kwargs: UpdateDashboardRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
    "Name": ...,
    "SourceEntity": ...,
}

parent.update_dashboard(**kwargs)

1. See UpdateDashboardRequestRequestTypeDef

update_dashboard_permissions

Updates read and write permissions on a dashboard.

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

Method definition

await def update_dashboard_permissions(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    GrantLinkPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokeLinkPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateDashboardPermissionsResponseTypeDef:  # (5)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See ResourcePermissionTypeDef
4. See ResourcePermissionTypeDef
5. See UpdateDashboardPermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateDashboardPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
}

parent.update_dashboard_permissions(**kwargs)

1. See UpdateDashboardPermissionsRequestRequestTypeDef

update_dashboard_published_version

Updates the published version of a dashboard.

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

Method definition

await def update_dashboard_published_version(
    self,
    *,
    AwsAccountId: str,
    DashboardId: str,
    VersionNumber: int,
) -> UpdateDashboardPublishedVersionResponseTypeDef:  # (1)
    ...

1. See UpdateDashboardPublishedVersionResponseTypeDef

Usage example with kwargs

kwargs: UpdateDashboardPublishedVersionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DashboardId": ...,
    "VersionNumber": ...,
}

parent.update_dashboard_published_version(**kwargs)

1. See UpdateDashboardPublishedVersionRequestRequestTypeDef

update_data_set

Updates a dataset.

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

Method definition

await def update_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)
    RowLevelPermissionDataSet: RowLevelPermissionDataSetTypeDef = ...,  # (6)
    RowLevelPermissionTagConfiguration: RowLevelPermissionTagConfigurationTypeDef = ...,  # (7)
    ColumnLevelPermissionRules: Sequence[ColumnLevelPermissionRuleTypeDef] = ...,  # (8)
    DataSetUsageConfiguration: DataSetUsageConfigurationTypeDef = ...,  # (9)
) -> UpdateDataSetResponseTypeDef:  # (10)
    ...

1. See PhysicalTableTypeDef
2. See DataSetImportModeType
3. See LogicalTableTypeDef
4. See ColumnGroupTypeDef
5. See FieldFolderTypeDef
6. See RowLevelPermissionDataSetTypeDef
7. See RowLevelPermissionTagConfigurationTypeDef
8. See ColumnLevelPermissionRuleTypeDef
9. See DataSetUsageConfigurationTypeDef
10. See UpdateDataSetResponseTypeDef

Usage example with kwargs

kwargs: UpdateDataSetRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
    "Name": ...,
    "PhysicalTableMap": ...,
    "ImportMode": ...,
}

parent.update_data_set(**kwargs)

1. See UpdateDataSetRequestRequestTypeDef

update_data_set_permissions

Updates the permissions on a dataset.

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

Method definition

await def update_data_set_permissions(
    self,
    *,
    AwsAccountId: str,
    DataSetId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateDataSetPermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateDataSetPermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateDataSetPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSetId": ...,
}

parent.update_data_set_permissions(**kwargs)

1. See UpdateDataSetPermissionsRequestRequestTypeDef

update_data_source

Updates a data source.

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

Method definition

await def update_data_source(
    self,
    *,
    AwsAccountId: str,
    DataSourceId: str,
    Name: str,
    DataSourceParameters: DataSourceParametersTypeDef = ...,  # (1)
    Credentials: DataSourceCredentialsTypeDef = ...,  # (2)
    VpcConnectionProperties: VpcConnectionPropertiesTypeDef = ...,  # (3)
    SslProperties: SslPropertiesTypeDef = ...,  # (4)
) -> UpdateDataSourceResponseTypeDef:  # (5)
    ...

1. See DataSourceParametersTypeDef
2. See DataSourceCredentialsTypeDef
3. See VpcConnectionPropertiesTypeDef
4. See SslPropertiesTypeDef
5. See UpdateDataSourceResponseTypeDef

Usage example with kwargs

kwargs: UpdateDataSourceRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
    "Name": ...,
}

parent.update_data_source(**kwargs)

1. See UpdateDataSourceRequestRequestTypeDef

update_data_source_permissions

Updates the permissions to a data source.

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

Method definition

await def update_data_source_permissions(
    self,
    *,
    AwsAccountId: str,
    DataSourceId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateDataSourcePermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateDataSourcePermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateDataSourcePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "DataSourceId": ...,
}

parent.update_data_source_permissions(**kwargs)

1. See UpdateDataSourcePermissionsRequestRequestTypeDef

update_folder

Updates the name of a folder.

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

Method definition

await def update_folder(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
    Name: str,
) -> UpdateFolderResponseTypeDef:  # (1)
    ...

1. See UpdateFolderResponseTypeDef

Usage example with kwargs

kwargs: UpdateFolderRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
    "Name": ...,
}

parent.update_folder(**kwargs)

1. See UpdateFolderRequestRequestTypeDef

update_folder_permissions

Updates permissions of a folder.

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

Method definition

await def update_folder_permissions(
    self,
    *,
    AwsAccountId: str,
    FolderId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateFolderPermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateFolderPermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateFolderPermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "FolderId": ...,
}

parent.update_folder_permissions(**kwargs)

1. See UpdateFolderPermissionsRequestRequestTypeDef

update_group

Changes a group description.

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

Method definition

await def update_group(
    self,
    *,
    GroupName: str,
    AwsAccountId: str,
    Namespace: str,
    Description: str = ...,
) -> UpdateGroupResponseTypeDef:  # (1)
    ...

1. See UpdateGroupResponseTypeDef

Usage example with kwargs

kwargs: UpdateGroupRequestRequestTypeDef = {  # (1)
    "GroupName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
}

parent.update_group(**kwargs)

1. See UpdateGroupRequestRequestTypeDef

update_iam_policy_assignment

Updates an existing IAM policy assignment.

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

Method definition

await def update_iam_policy_assignment(
    self,
    *,
    AwsAccountId: str,
    AssignmentName: str,
    Namespace: str,
    AssignmentStatus: AssignmentStatusType = ...,  # (1)
    PolicyArn: str = ...,
    Identities: Mapping[str, Sequence[str]] = ...,
) -> UpdateIAMPolicyAssignmentResponseTypeDef:  # (2)
    ...

1. See AssignmentStatusType
2. See UpdateIAMPolicyAssignmentResponseTypeDef

Usage example with kwargs

kwargs: UpdateIAMPolicyAssignmentRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "AssignmentName": ...,
    "Namespace": ...,
}

parent.update_iam_policy_assignment(**kwargs)

1. See UpdateIAMPolicyAssignmentRequestRequestTypeDef

update_ip_restriction

Updates the content and status of IP rules.

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

Method definition

await def update_ip_restriction(
    self,
    *,
    AwsAccountId: str,
    IpRestrictionRuleMap: Mapping[str, str] = ...,
    Enabled: bool = ...,
) -> UpdateIpRestrictionResponseTypeDef:  # (1)
    ...

1. See UpdateIpRestrictionResponseTypeDef

Usage example with kwargs

kwargs: UpdateIpRestrictionRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.update_ip_restriction(**kwargs)

1. See UpdateIpRestrictionRequestRequestTypeDef

update_public_sharing_settings

Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.

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

Method definition

await def update_public_sharing_settings(
    self,
    *,
    AwsAccountId: str,
    PublicSharingEnabled: bool = ...,
) -> UpdatePublicSharingSettingsResponseTypeDef:  # (1)
    ...

1. See UpdatePublicSharingSettingsResponseTypeDef

Usage example with kwargs

kwargs: UpdatePublicSharingSettingsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
}

parent.update_public_sharing_settings(**kwargs)

1. See UpdatePublicSharingSettingsRequestRequestTypeDef

update_template

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

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

Method definition

await def update_template(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    SourceEntity: TemplateSourceEntityTypeDef,  # (1)
    VersionDescription: str = ...,
    Name: str = ...,
) -> UpdateTemplateResponseTypeDef:  # (2)
    ...

1. See TemplateSourceEntityTypeDef
2. See UpdateTemplateResponseTypeDef

Usage example with kwargs

kwargs: UpdateTemplateRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "SourceEntity": ...,
}

parent.update_template(**kwargs)

1. See UpdateTemplateRequestRequestTypeDef

update_template_alias

Updates the template alias of a template.

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

Method definition

await def update_template_alias(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    AliasName: str,
    TemplateVersionNumber: int,
) -> UpdateTemplateAliasResponseTypeDef:  # (1)
    ...

1. See UpdateTemplateAliasResponseTypeDef

Usage example with kwargs

kwargs: UpdateTemplateAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
    "AliasName": ...,
    "TemplateVersionNumber": ...,
}

parent.update_template_alias(**kwargs)

1. See UpdateTemplateAliasRequestRequestTypeDef

update_template_permissions

Updates the resource permissions for a template.

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

Method definition

await def update_template_permissions(
    self,
    *,
    AwsAccountId: str,
    TemplateId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateTemplatePermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateTemplatePermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateTemplatePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "TemplateId": ...,
}

parent.update_template_permissions(**kwargs)

1. See UpdateTemplatePermissionsRequestRequestTypeDef

update_theme

Updates a theme.

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

Method definition

await def update_theme(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    BaseThemeId: str,
    Name: str = ...,
    VersionDescription: str = ...,
    Configuration: ThemeConfigurationTypeDef = ...,  # (1)
) -> UpdateThemeResponseTypeDef:  # (2)
    ...

1. See ThemeConfigurationTypeDef
2. See UpdateThemeResponseTypeDef

Usage example with kwargs

kwargs: UpdateThemeRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "BaseThemeId": ...,
}

parent.update_theme(**kwargs)

1. See UpdateThemeRequestRequestTypeDef

update_theme_alias

Updates an alias of a theme.

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

Method definition

await def update_theme_alias(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    AliasName: str,
    ThemeVersionNumber: int,
) -> UpdateThemeAliasResponseTypeDef:  # (1)
    ...

1. See UpdateThemeAliasResponseTypeDef

Usage example with kwargs

kwargs: UpdateThemeAliasRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
    "AliasName": ...,
    "ThemeVersionNumber": ...,
}

parent.update_theme_alias(**kwargs)

1. See UpdateThemeAliasRequestRequestTypeDef

update_theme_permissions

Updates the resource permissions for a theme.

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

Method definition

await def update_theme_permissions(
    self,
    *,
    AwsAccountId: str,
    ThemeId: str,
    GrantPermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
    RevokePermissions: Sequence[ResourcePermissionTypeDef] = ...,  # (1)
) -> UpdateThemePermissionsResponseTypeDef:  # (3)
    ...

1. See ResourcePermissionTypeDef
2. See ResourcePermissionTypeDef
3. See UpdateThemePermissionsResponseTypeDef

Usage example with kwargs

kwargs: UpdateThemePermissionsRequestRequestTypeDef = {  # (1)
    "AwsAccountId": ...,
    "ThemeId": ...,
}

parent.update_theme_permissions(**kwargs)

1. See UpdateThemePermissionsRequestRequestTypeDef

update_user

Updates an Amazon QuickSight user.

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

Method definition

await def update_user(
    self,
    *,
    UserName: str,
    AwsAccountId: str,
    Namespace: str,
    Email: str,
    Role: UserRoleType,  # (1)
    CustomPermissionsName: str = ...,
    UnapplyCustomPermissions: bool = ...,
    ExternalLoginFederationProviderType: str = ...,
    CustomFederationProviderUrl: str = ...,
    ExternalLoginId: str = ...,
) -> UpdateUserResponseTypeDef:  # (2)
    ...

1. See UserRoleType
2. See UpdateUserResponseTypeDef

Usage example with kwargs

kwargs: UpdateUserRequestRequestTypeDef = {  # (1)
    "UserName": ...,
    "AwsAccountId": ...,
    "Namespace": ...,
    "Email": ...,
    "Role": ...,
}

parent.update_user(**kwargs)

1. See UpdateUserRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> QuickSightClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("quicksight").get_paginator method with overloads.

• client.get_paginator("list_analyses") -> ListAnalysesPaginator
• client.get_paginator("list_dashboard_versions") -> ListDashboardVersionsPaginator
• client.get_paginator("list_dashboards") -> ListDashboardsPaginator
• client.get_paginator("list_data_sets") -> ListDataSetsPaginator
• client.get_paginator("list_data_sources") -> ListDataSourcesPaginator
• client.get_paginator("list_ingestions") -> ListIngestionsPaginator
• client.get_paginator("list_namespaces") -> ListNamespacesPaginator
• client.get_paginator("list_template_aliases") -> ListTemplateAliasesPaginator
• client.get_paginator("list_template_versions") -> ListTemplateVersionsPaginator
• client.get_paginator("list_templates") -> ListTemplatesPaginator
• client.get_paginator("list_theme_versions") -> ListThemeVersionsPaginator
• client.get_paginator("list_themes") -> ListThemesPaginator
• client.get_paginator("search_analyses") -> SearchAnalysesPaginator
• client.get_paginator("search_dashboards") -> SearchDashboardsPaginator