QuickSightClient
Index > QuickSight > QuickSightClient
Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.
QuickSightClient
Type annotations and code completion for boto3.client("quicksight")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_quicksight.client import QuickSightClient
def get_quicksight_client() -> QuickSightClient:
return Session().client("quicksight")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("quicksight").exceptions
structure.
client = boto3.client("quicksight")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConcurrentUpdatingException,
client.ConflictException,
client.DomainNotWhitelistedException,
client.IdentityTypeNotSupportedException,
client.InternalFailureException,
client.InvalidNextTokenException,
client.InvalidParameterValueException,
client.InvalidRequestException,
client.LimitExceededException,
client.PreconditionNotMetException,
client.QuickSightUserNotFoundException,
client.ResourceExistsException,
client.ResourceNotFoundException,
client.ResourceUnavailableException,
client.SessionLifetimeInMinutesInvalidException,
client.ThrottlingException,
client.UnsupportedPricingPlanException,
client.UnsupportedUserEditionException,
) as e:
print(e)
from mypy_boto3_quicksight.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("quicksight").can_paginate
method.
boto3 documentation
cancel_ingestion
Cancels an ongoing ingestion of data into SPICE.
Type annotations and code completion for boto3.client("quicksight").cancel_ingestion
method.
boto3 documentation
def cancel_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> CancelIngestionResponseTypeDef: # (1)
...
kwargs: CancelIngestionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"IngestionId": ...,
}
parent.cancel_ingestion(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("quicksight").close
method.
boto3 documentation
create_account_customization
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").create_account_customization
method.
boto3 documentation
def create_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAccountCustomizationResponseTypeDef: # (3)
...
kwargs: CreateAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AccountCustomization": ...,
}
parent.create_account_customization(**kwargs)
create_account_subscription
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
Type annotations and code completion for boto3.client("quicksight").create_account_subscription
method.
boto3 documentation
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)
...
kwargs: CreateAccountSubscriptionRequestRequestTypeDef = { # (1)
"Edition": ...,
"AuthenticationMethod": ...,
"AwsAccountId": ...,
"AccountName": ...,
"NotificationEmail": ...,
}
parent.create_account_subscription(**kwargs)
create_analysis
Creates an analysis in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_analysis
method.
boto3 documentation
def create_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
SourceEntity: AnalysisSourceEntityTypeDef = ..., # (3)
ThemeArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
Definition: AnalysisDefinitionTypeDef = ..., # (5)
) -> CreateAnalysisResponseTypeDef: # (6)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See AnalysisSourceEntityTypeDef
- See TagTypeDef
- See AnalysisDefinitionTypeDef
- See CreateAnalysisResponseTypeDef
kwargs: CreateAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
"Name": ...,
}
parent.create_analysis(**kwargs)
create_dashboard
Creates a dashboard from either a template or directly with a
DashboardDefinition
.
Type annotations and code completion for boto3.client("quicksight").create_dashboard
method.
boto3 documentation
def create_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
SourceEntity: DashboardSourceEntityTypeDef = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
VersionDescription: str = ...,
DashboardPublishOptions: DashboardPublishOptionsTypeDef = ..., # (5)
ThemeArn: str = ...,
Definition: DashboardVersionDefinitionTypeDef = ..., # (6)
) -> CreateDashboardResponseTypeDef: # (7)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See DashboardSourceEntityTypeDef
- See TagTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See CreateDashboardResponseTypeDef
kwargs: CreateDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"Name": ...,
}
parent.create_dashboard(**kwargs)
create_data_set
Creates a dataset.
Type annotations and code completion for boto3.client("quicksight").create_data_set
method.
boto3 documentation
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)
...
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See ResourcePermissionTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See TagTypeDef
- See DataSetUsageConfigurationTypeDef
- See CreateDataSetResponseTypeDef
kwargs: CreateDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"Name": ...,
"PhysicalTableMap": ...,
"ImportMode": ...,
}
parent.create_data_set(**kwargs)
create_data_source
Creates a data source.
Type annotations and code completion for boto3.client("quicksight").create_data_source
method.
boto3 documentation
def create_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
Name: str,
Type: DataSourceTypeType, # (1)
DataSourceParameters: DataSourceParametersTypeDef = ..., # (2)
Credentials: DataSourceCredentialsTypeDef = ..., # (3)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (4)
VpcConnectionProperties: VpcConnectionPropertiesTypeDef = ..., # (5)
SslProperties: SslPropertiesTypeDef = ..., # (6)
Tags: Sequence[TagTypeDef] = ..., # (7)
) -> CreateDataSourceResponseTypeDef: # (8)
...
- See DataSourceTypeType
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See ResourcePermissionTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See TagTypeDef
- See CreateDataSourceResponseTypeDef
kwargs: CreateDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
"Name": ...,
"Type": ...,
}
parent.create_data_source(**kwargs)
create_folder
Creates an empty shared folder.
Type annotations and code completion for boto3.client("quicksight").create_folder
method.
boto3 documentation
def create_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
Name: str = ...,
FolderType: FolderTypeType = ..., # (1)
ParentFolderArn: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateFolderResponseTypeDef: # (4)
...
- See FolderTypeType
- See ResourcePermissionTypeDef
- See TagTypeDef
- See CreateFolderResponseTypeDef
kwargs: CreateFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.create_folder(**kwargs)
create_folder_membership
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
Type annotations and code completion for boto3.client("quicksight").create_folder_membership
method.
boto3 documentation
def create_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> CreateFolderMembershipResponseTypeDef: # (2)
...
kwargs: CreateFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.create_folder_membership(**kwargs)
create_group
Use the CreateGroup
operation to create a group in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_group
method.
boto3 documentation
def create_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group(**kwargs)
create_group_membership
Adds an Amazon QuickSight user to an Amazon QuickSight group.
Type annotations and code completion for boto3.client("quicksight").create_group_membership
method.
boto3 documentation
def create_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> CreateGroupMembershipResponseTypeDef: # (1)
...
kwargs: CreateGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group_membership(**kwargs)
create_iam_policy_assignment
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("quicksight").create_iam_policy_assignment
method.
boto3 documentation
def create_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
AssignmentStatus: AssignmentStatusType, # (1)
Namespace: str,
PolicyArn: str = ...,
Identities: Mapping[str, Sequence[str]] = ...,
) -> CreateIAMPolicyAssignmentResponseTypeDef: # (2)
...
kwargs: CreateIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"AssignmentStatus": ...,
"Namespace": ...,
}
parent.create_iam_policy_assignment(**kwargs)
create_ingestion
Creates and starts a new SPICE ingestion for a dataset.
Type annotations and code completion for boto3.client("quicksight").create_ingestion
method.
boto3 documentation
def create_ingestion(
self,
*,
DataSetId: str,
IngestionId: str,
AwsAccountId: str,
IngestionType: IngestionTypeType = ..., # (1)
) -> CreateIngestionResponseTypeDef: # (2)
...
kwargs: CreateIngestionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"IngestionId": ...,
"AwsAccountId": ...,
}
parent.create_ingestion(**kwargs)
create_namespace
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_namespace
method.
boto3 documentation
def create_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
IdentityStore: IdentityStoreType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateNamespaceResponseTypeDef: # (3)
...
kwargs: CreateNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"IdentityStore": ...,
}
parent.create_namespace(**kwargs)
create_template
Creates a template either from a TemplateDefinition
or from an existing Amazon
QuickSight analysis or template.
Type annotations and code completion for boto3.client("quicksight").create_template
method.
boto3 documentation
def create_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
Name: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
SourceEntity: TemplateSourceEntityTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
VersionDescription: str = ...,
Definition: TemplateVersionDefinitionTypeDef = ..., # (4)
) -> CreateTemplateResponseTypeDef: # (5)
...
- See ResourcePermissionTypeDef
- See TemplateSourceEntityTypeDef
- See TagTypeDef
- See TemplateVersionDefinitionTypeDef
- See CreateTemplateResponseTypeDef
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.create_template(**kwargs)
create_template_alias
Creates a template alias for a template.
Type annotations and code completion for boto3.client("quicksight").create_template_alias
method.
boto3 documentation
def create_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
) -> CreateTemplateAliasResponseTypeDef: # (1)
...
kwargs: CreateTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
"TemplateVersionNumber": ...,
}
parent.create_template_alias(**kwargs)
create_theme
Creates a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme
method.
boto3 documentation
def create_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
Name: str,
BaseThemeId: str,
Configuration: ThemeConfigurationTypeDef, # (1)
VersionDescription: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateThemeResponseTypeDef: # (4)
...
- See ThemeConfigurationTypeDef
- See ResourcePermissionTypeDef
- See TagTypeDef
- See CreateThemeResponseTypeDef
kwargs: CreateThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"Name": ...,
"BaseThemeId": ...,
"Configuration": ...,
}
parent.create_theme(**kwargs)
create_theme_alias
Creates a theme alias for a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme_alias
method.
boto3 documentation
def create_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
) -> CreateThemeAliasResponseTypeDef: # (1)
...
kwargs: CreateThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
"ThemeVersionNumber": ...,
}
parent.create_theme_alias(**kwargs)
delete_account_customization
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
Type annotations and code completion for boto3.client("quicksight").delete_account_customization
method.
boto3 documentation
def delete_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
) -> DeleteAccountCustomizationResponseTypeDef: # (1)
...
kwargs: DeleteAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_customization(**kwargs)
delete_account_subscription
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight
account.
Type annotations and code completion for boto3.client("quicksight").delete_account_subscription
method.
boto3 documentation
def delete_account_subscription(
self,
*,
AwsAccountId: str,
) -> DeleteAccountSubscriptionResponseTypeDef: # (1)
...
kwargs: DeleteAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_subscription(**kwargs)
delete_analysis
Deletes an analysis from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_analysis
method.
boto3 documentation
def delete_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
RecoveryWindowInDays: int = ...,
ForceDeleteWithoutRecovery: bool = ...,
) -> DeleteAnalysisResponseTypeDef: # (1)
...
kwargs: DeleteAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.delete_analysis(**kwargs)
delete_dashboard
Deletes a dashboard.
Type annotations and code completion for boto3.client("quicksight").delete_dashboard
method.
boto3 documentation
def delete_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
) -> DeleteDashboardResponseTypeDef: # (1)
...
kwargs: DeleteDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.delete_dashboard(**kwargs)
delete_data_set
Deletes a dataset.
Type annotations and code completion for boto3.client("quicksight").delete_data_set
method.
boto3 documentation
def delete_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DeleteDataSetResponseTypeDef: # (1)
...
kwargs: DeleteDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.delete_data_set(**kwargs)
delete_data_source
Deletes the data source permanently.
Type annotations and code completion for boto3.client("quicksight").delete_data_source
method.
boto3 documentation
def delete_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DeleteDataSourceResponseTypeDef: # (1)
...
kwargs: DeleteDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.delete_data_source(**kwargs)
delete_folder
Deletes an empty folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder
method.
boto3 documentation
def delete_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DeleteFolderResponseTypeDef: # (1)
...
kwargs: DeleteFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.delete_folder(**kwargs)
delete_folder_membership
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder_membership
method.
boto3 documentation
def delete_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> DeleteFolderMembershipResponseTypeDef: # (2)
...
kwargs: DeleteFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.delete_folder_membership(**kwargs)
delete_group
Removes a user group from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_group
method.
boto3 documentation
def delete_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupResponseTypeDef: # (1)
...
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group(**kwargs)
delete_group_membership
Removes a user from a group so that the user is no longer a member of the group.
Type annotations and code completion for boto3.client("quicksight").delete_group_membership
method.
boto3 documentation
def delete_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupMembershipResponseTypeDef: # (1)
...
kwargs: DeleteGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group_membership(**kwargs)
delete_iam_policy_assignment
Deletes an existing IAM policy assignment.
Type annotations and code completion for boto3.client("quicksight").delete_iam_policy_assignment
method.
boto3 documentation
def delete_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
) -> DeleteIAMPolicyAssignmentResponseTypeDef: # (1)
...
kwargs: DeleteIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.delete_iam_policy_assignment(**kwargs)
delete_namespace
Deletes a namespace and the users and groups that are associated with the namespace.
Type annotations and code completion for boto3.client("quicksight").delete_namespace
method.
boto3 documentation
def delete_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
) -> DeleteNamespaceResponseTypeDef: # (1)
...
kwargs: DeleteNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_namespace(**kwargs)
delete_template
Deletes a template.
Type annotations and code completion for boto3.client("quicksight").delete_template
method.
boto3 documentation
def delete_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
) -> DeleteTemplateResponseTypeDef: # (1)
...
kwargs: DeleteTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.delete_template(**kwargs)
delete_template_alias
Deletes the item that the specified template alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_template_alias
method.
boto3 documentation
def delete_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
) -> DeleteTemplateAliasResponseTypeDef: # (1)
...
kwargs: DeleteTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
}
parent.delete_template_alias(**kwargs)
delete_theme
Deletes a theme.
Type annotations and code completion for boto3.client("quicksight").delete_theme
method.
boto3 documentation
def delete_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
VersionNumber: int = ...,
) -> DeleteThemeResponseTypeDef: # (1)
...
kwargs: DeleteThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.delete_theme(**kwargs)
delete_theme_alias
Deletes the version of the theme that the specified theme alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_theme_alias
method.
boto3 documentation
def delete_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
) -> DeleteThemeAliasResponseTypeDef: # (1)
...
kwargs: DeleteThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
}
parent.delete_theme_alias(**kwargs)
delete_user
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
Type annotations and code completion for boto3.client("quicksight").delete_user
method.
boto3 documentation
def delete_user(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserResponseTypeDef: # (1)
...
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user(**kwargs)
delete_user_by_principal_id
Deletes a user identified by its principal ID.
Type annotations and code completion for boto3.client("quicksight").delete_user_by_principal_id
method.
boto3 documentation
def delete_user_by_principal_id(
self,
*,
PrincipalId: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserByPrincipalIdResponseTypeDef: # (1)
...
kwargs: DeleteUserByPrincipalIdRequestRequestTypeDef = { # (1)
"PrincipalId": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user_by_principal_id(**kwargs)
describe_account_customization
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").describe_account_customization
method.
boto3 documentation
def describe_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
Resolved: bool = ...,
) -> DescribeAccountCustomizationResponseTypeDef: # (1)
...
kwargs: DescribeAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_customization(**kwargs)
describe_account_settings
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").describe_account_settings
method.
boto3 documentation
def describe_account_settings(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSettingsResponseTypeDef: # (1)
...
kwargs: DescribeAccountSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_settings(**kwargs)
describe_account_subscription
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
Type annotations and code completion for boto3.client("quicksight").describe_account_subscription
method.
boto3 documentation
def describe_account_subscription(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSubscriptionResponseTypeDef: # (1)
...
kwargs: DescribeAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_subscription(**kwargs)
describe_analysis
Provides a summary of the metadata for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis
method.
boto3 documentation
def describe_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisResponseTypeDef: # (1)
...
kwargs: DescribeAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis(**kwargs)
describe_analysis_definition
Provides a detailed description of the definition of an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_definition
method.
boto3 documentation
def describe_analysis_definition(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisDefinitionResponseTypeDef: # (1)
...
kwargs: DescribeAnalysisDefinitionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_definition(**kwargs)
describe_analysis_permissions
Provides the read and write permissions for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_permissions
method.
boto3 documentation
def describe_analysis_permissions(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisPermissionsResponseTypeDef: # (1)
...
kwargs: DescribeAnalysisPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_permissions(**kwargs)
describe_dashboard
Provides a summary for a dashboard.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard
method.
boto3 documentation
def describe_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeDashboardResponseTypeDef: # (1)
...
kwargs: DescribeDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.describe_dashboard(**kwargs)
describe_dashboard_definition
Provides a detailed description of the definition of a dashboard.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard_definition
method.
boto3 documentation
def describe_dashboard_definition(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeDashboardDefinitionResponseTypeDef: # (1)
...
kwargs: DescribeDashboardDefinitionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.describe_dashboard_definition(**kwargs)
describe_dashboard_permissions
Describes read and write permissions for a dashboard.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard_permissions
method.
boto3 documentation
def describe_dashboard_permissions(
self,
*,
AwsAccountId: str,
DashboardId: str,
) -> DescribeDashboardPermissionsResponseTypeDef: # (1)
...
kwargs: DescribeDashboardPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.describe_dashboard_permissions(**kwargs)
describe_data_set
Describes a dataset.
Type annotations and code completion for boto3.client("quicksight").describe_data_set
method.
boto3 documentation
def describe_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DescribeDataSetResponseTypeDef: # (1)
...
kwargs: DescribeDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.describe_data_set(**kwargs)
describe_data_set_permissions
Describes the permissions on a dataset.
Type annotations and code completion for boto3.client("quicksight").describe_data_set_permissions
method.
boto3 documentation
def describe_data_set_permissions(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DescribeDataSetPermissionsResponseTypeDef: # (1)
...
kwargs: DescribeDataSetPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.describe_data_set_permissions(**kwargs)
describe_data_source
Describes a data source.
Type annotations and code completion for boto3.client("quicksight").describe_data_source
method.
boto3 documentation
def describe_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DescribeDataSourceResponseTypeDef: # (1)
...
kwargs: DescribeDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.describe_data_source(**kwargs)
describe_data_source_permissions
Describes the resource permissions for a data source.
Type annotations and code completion for boto3.client("quicksight").describe_data_source_permissions
method.
boto3 documentation
def describe_data_source_permissions(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DescribeDataSourcePermissionsResponseTypeDef: # (1)
...
kwargs: DescribeDataSourcePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.describe_data_source_permissions(**kwargs)
describe_folder
Describes a folder.
Type annotations and code completion for boto3.client("quicksight").describe_folder
method.
boto3 documentation
def describe_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DescribeFolderResponseTypeDef: # (1)
...
kwargs: DescribeFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.describe_folder(**kwargs)
describe_folder_permissions
Describes permissions for a folder.
Type annotations and code completion for boto3.client("quicksight").describe_folder_permissions
method.
boto3 documentation
def describe_folder_permissions(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DescribeFolderPermissionsResponseTypeDef: # (1)
...
kwargs: DescribeFolderPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.describe_folder_permissions(**kwargs)
describe_folder_resolved_permissions
Describes the folder resolved permissions.
Type annotations and code completion for boto3.client("quicksight").describe_folder_resolved_permissions
method.
boto3 documentation
def describe_folder_resolved_permissions(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DescribeFolderResolvedPermissionsResponseTypeDef: # (1)
...
kwargs: DescribeFolderResolvedPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.describe_folder_resolved_permissions(**kwargs)
describe_group
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("quicksight").describe_group
method.
boto3 documentation
def describe_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeGroupResponseTypeDef: # (1)
...
kwargs: DescribeGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_group(**kwargs)
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 boto3.client("quicksight").describe_group_membership
method.
boto3 documentation
def describe_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeGroupMembershipResponseTypeDef: # (1)
...
kwargs: DescribeGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_group_membership(**kwargs)
describe_iam_policy_assignment
Describes an existing IAM policy assignment, as specified by the assignment name.
Type annotations and code completion for boto3.client("quicksight").describe_iam_policy_assignment
method.
boto3 documentation
def describe_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
) -> DescribeIAMPolicyAssignmentResponseTypeDef: # (1)
...
kwargs: DescribeIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.describe_iam_policy_assignment(**kwargs)
describe_ingestion
Describes a SPICE ingestion.
Type annotations and code completion for boto3.client("quicksight").describe_ingestion
method.
boto3 documentation
def describe_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> DescribeIngestionResponseTypeDef: # (1)
...
kwargs: DescribeIngestionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"IngestionId": ...,
}
parent.describe_ingestion(**kwargs)
describe_ip_restriction
Provides a summary and status of IP rules.
Type annotations and code completion for boto3.client("quicksight").describe_ip_restriction
method.
boto3 documentation
def describe_ip_restriction(
self,
*,
AwsAccountId: str,
) -> DescribeIpRestrictionResponseTypeDef: # (1)
...
kwargs: DescribeIpRestrictionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_ip_restriction(**kwargs)
describe_namespace
Describes the current namespace.
Type annotations and code completion for boto3.client("quicksight").describe_namespace
method.
boto3 documentation
def describe_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
) -> DescribeNamespaceResponseTypeDef: # (1)
...
kwargs: DescribeNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_namespace(**kwargs)
describe_template
Describes a template's metadata.
Type annotations and code completion for boto3.client("quicksight").describe_template
method.
boto3 documentation
def describe_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeTemplateResponseTypeDef: # (1)
...
kwargs: DescribeTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.describe_template(**kwargs)
describe_template_alias
Describes the template alias for a template.
Type annotations and code completion for boto3.client("quicksight").describe_template_alias
method.
boto3 documentation
def describe_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
) -> DescribeTemplateAliasResponseTypeDef: # (1)
...
kwargs: DescribeTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
}
parent.describe_template_alias(**kwargs)
describe_template_definition
Provides a detailed description of the definition of a template.
Type annotations and code completion for boto3.client("quicksight").describe_template_definition
method.
boto3 documentation
def describe_template_definition(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeTemplateDefinitionResponseTypeDef: # (1)
...
kwargs: DescribeTemplateDefinitionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.describe_template_definition(**kwargs)
describe_template_permissions
Describes read and write permissions on a template.
Type annotations and code completion for boto3.client("quicksight").describe_template_permissions
method.
boto3 documentation
def describe_template_permissions(
self,
*,
AwsAccountId: str,
TemplateId: str,
) -> DescribeTemplatePermissionsResponseTypeDef: # (1)
...
kwargs: DescribeTemplatePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.describe_template_permissions(**kwargs)
describe_theme
Describes a theme.
Type annotations and code completion for boto3.client("quicksight").describe_theme
method.
boto3 documentation
def describe_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeThemeResponseTypeDef: # (1)
...
kwargs: DescribeThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.describe_theme(**kwargs)
describe_theme_alias
Describes the alias for a theme.
Type annotations and code completion for boto3.client("quicksight").describe_theme_alias
method.
boto3 documentation
def describe_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
) -> DescribeThemeAliasResponseTypeDef: # (1)
...
kwargs: DescribeThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
}
parent.describe_theme_alias(**kwargs)
describe_theme_permissions
Describes the read and write permissions for a theme.
Type annotations and code completion for boto3.client("quicksight").describe_theme_permissions
method.
boto3 documentation
def describe_theme_permissions(
self,
*,
AwsAccountId: str,
ThemeId: str,
) -> DescribeThemePermissionsResponseTypeDef: # (1)
...
kwargs: DescribeThemePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.describe_theme_permissions(**kwargs)
describe_user
Returns information about a user, given the user name.
Type annotations and code completion for boto3.client("quicksight").describe_user
method.
boto3 documentation
def describe_user(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeUserResponseTypeDef: # (1)
...
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_user(**kwargs)
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 boto3.client("quicksight").generate_embed_url_for_anonymous_user
method.
boto3 documentation
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)
...
- See AnonymousUserEmbeddingExperienceConfigurationTypeDef
- See SessionTagTypeDef
- See GenerateEmbedUrlForAnonymousUserResponseTypeDef
kwargs: GenerateEmbedUrlForAnonymousUserRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"AuthorizedResourceArns": ...,
"ExperienceConfiguration": ...,
}
parent.generate_embed_url_for_anonymous_user(**kwargs)
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 boto3.client("quicksight").generate_embed_url_for_registered_user
method.
boto3 documentation
def generate_embed_url_for_registered_user(
self,
*,
AwsAccountId: str,
UserArn: str,
ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfigurationTypeDef, # (1)
SessionLifetimeInMinutes: int = ...,
AllowedDomains: Sequence[str] = ...,
) -> GenerateEmbedUrlForRegisteredUserResponseTypeDef: # (2)
...
- See RegisteredUserEmbeddingExperienceConfigurationTypeDef
- See GenerateEmbedUrlForRegisteredUserResponseTypeDef
kwargs: GenerateEmbedUrlForRegisteredUserRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"UserArn": ...,
"ExperienceConfiguration": ...,
}
parent.generate_embed_url_for_registered_user(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("quicksight").generate_presigned_url
method.
boto3 documentation
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 boto3.client("quicksight").get_dashboard_embed_url
method.
boto3 documentation
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)
...
kwargs: GetDashboardEmbedUrlRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"IdentityType": ...,
}
parent.get_dashboard_embed_url(**kwargs)
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 boto3.client("quicksight").get_session_embed_url
method.
boto3 documentation
def get_session_embed_url(
self,
*,
AwsAccountId: str,
EntryPoint: str = ...,
SessionLifetimeInMinutes: int = ...,
UserArn: str = ...,
) -> GetSessionEmbedUrlResponseTypeDef: # (1)
...
kwargs: GetSessionEmbedUrlRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.get_session_embed_url(**kwargs)
list_analyses
Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_analyses
method.
boto3 documentation
def list_analyses(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAnalysesResponseTypeDef: # (1)
...
kwargs: ListAnalysesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_analyses(**kwargs)
list_dashboard_versions
Lists all the versions of the dashboards in the Amazon QuickSight subscription.
Type annotations and code completion for boto3.client("quicksight").list_dashboard_versions
method.
boto3 documentation
def list_dashboard_versions(
self,
*,
AwsAccountId: str,
DashboardId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDashboardVersionsResponseTypeDef: # (1)
...
kwargs: ListDashboardVersionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.list_dashboard_versions(**kwargs)
list_dashboards
Lists dashboards in an Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_dashboards
method.
boto3 documentation
def list_dashboards(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDashboardsResponseTypeDef: # (1)
...
kwargs: ListDashboardsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_dashboards(**kwargs)
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 boto3.client("quicksight").list_data_sets
method.
boto3 documentation
def list_data_sets(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataSetsResponseTypeDef: # (1)
...
kwargs: ListDataSetsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_data_sets(**kwargs)
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 boto3.client("quicksight").list_data_sources
method.
boto3 documentation
def list_data_sources(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef: # (1)
...
kwargs: ListDataSourcesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_data_sources(**kwargs)
list_folder_members
List all assets ( DASHBOARD
, ANALYSIS
, and DATASET
) in a folder.
Type annotations and code completion for boto3.client("quicksight").list_folder_members
method.
boto3 documentation
def list_folder_members(
self,
*,
AwsAccountId: str,
FolderId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFolderMembersResponseTypeDef: # (1)
...
kwargs: ListFolderMembersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.list_folder_members(**kwargs)
list_folders
Lists all folders in an account.
Type annotations and code completion for boto3.client("quicksight").list_folders
method.
boto3 documentation
def list_folders(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFoldersResponseTypeDef: # (1)
...
kwargs: ListFoldersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_folders(**kwargs)
list_group_memberships
Lists member users in a group.
Type annotations and code completion for boto3.client("quicksight").list_group_memberships
method.
boto3 documentation
def list_group_memberships(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGroupMembershipsResponseTypeDef: # (1)
...
kwargs: ListGroupMembershipsRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_group_memberships(**kwargs)
list_groups
Lists all user groups in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").list_groups
method.
boto3 documentation
def list_groups(
self,
*,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGroupsResponseTypeDef: # (1)
...
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_groups(**kwargs)
list_iam_policy_assignments
Lists IAM policy assignments in the current Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").list_iam_policy_assignments
method.
boto3 documentation
def list_iam_policy_assignments(
self,
*,
AwsAccountId: str,
Namespace: str,
AssignmentStatus: AssignmentStatusType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsResponseTypeDef: # (2)
...
kwargs: ListIAMPolicyAssignmentsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_iam_policy_assignments(**kwargs)
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 boto3.client("quicksight").list_iam_policy_assignments_for_user
method.
boto3 documentation
def list_iam_policy_assignments_for_user(
self,
*,
AwsAccountId: str,
UserName: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsForUserResponseTypeDef: # (1)
...
kwargs: ListIAMPolicyAssignmentsForUserRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"UserName": ...,
"Namespace": ...,
}
parent.list_iam_policy_assignments_for_user(**kwargs)
list_ingestions
Lists the history of SPICE ingestions for a dataset.
Type annotations and code completion for boto3.client("quicksight").list_ingestions
method.
boto3 documentation
def list_ingestions(
self,
*,
DataSetId: str,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIngestionsResponseTypeDef: # (1)
...
kwargs: ListIngestionsRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
}
parent.list_ingestions(**kwargs)
list_namespaces
Lists the namespaces for the specified Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_namespaces
method.
boto3 documentation
def list_namespaces(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListNamespacesResponseTypeDef: # (1)
...
kwargs: ListNamespacesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_namespaces(**kwargs)
list_tags_for_resource
Lists the tags assigned to a resource.
Type annotations and code completion for boto3.client("quicksight").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_template_aliases
Lists all the aliases of a template.
Type annotations and code completion for boto3.client("quicksight").list_template_aliases
method.
boto3 documentation
def list_template_aliases(
self,
*,
AwsAccountId: str,
TemplateId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplateAliasesResponseTypeDef: # (1)
...
kwargs: ListTemplateAliasesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.list_template_aliases(**kwargs)
list_template_versions
Lists all the versions of the templates in the current Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").list_template_versions
method.
boto3 documentation
def list_template_versions(
self,
*,
AwsAccountId: str,
TemplateId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplateVersionsResponseTypeDef: # (1)
...
kwargs: ListTemplateVersionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.list_template_versions(**kwargs)
list_templates
Lists all the templates in the current Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").list_templates
method.
boto3 documentation
def list_templates(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplatesResponseTypeDef: # (1)
...
kwargs: ListTemplatesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_templates(**kwargs)
list_theme_aliases
Lists all the aliases of a theme.
Type annotations and code completion for boto3.client("quicksight").list_theme_aliases
method.
boto3 documentation
def list_theme_aliases(
self,
*,
AwsAccountId: str,
ThemeId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListThemeAliasesResponseTypeDef: # (1)
...
kwargs: ListThemeAliasesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.list_theme_aliases(**kwargs)
list_theme_versions
Lists all the versions of the themes in the current Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_theme_versions
method.
boto3 documentation
def list_theme_versions(
self,
*,
AwsAccountId: str,
ThemeId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListThemeVersionsResponseTypeDef: # (1)
...
kwargs: ListThemeVersionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.list_theme_versions(**kwargs)
list_themes
Lists all the themes in the current Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_themes
method.
boto3 documentation
def list_themes(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
Type: ThemeTypeType = ..., # (1)
) -> ListThemesResponseTypeDef: # (2)
...
kwargs: ListThemesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_themes(**kwargs)
list_user_groups
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
Type annotations and code completion for boto3.client("quicksight").list_user_groups
method.
boto3 documentation
def list_user_groups(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUserGroupsResponseTypeDef: # (1)
...
kwargs: ListUserGroupsRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_user_groups(**kwargs)
list_users
Returns a list of all of the Amazon QuickSight users belonging to this account.
Type annotations and code completion for boto3.client("quicksight").list_users
method.
boto3 documentation
def list_users(
self,
*,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_users(**kwargs)
register_user
Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.
Type annotations and code completion for boto3.client("quicksight").register_user
method.
boto3 documentation
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)
...
- See IdentityTypeType
- See UserRoleType
- See RegisterUserResponseTypeDef
kwargs: RegisterUserRequestRequestTypeDef = { # (1)
"IdentityType": ...,
"Email": ...,
"UserRole": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.register_user(**kwargs)
restore_analysis
Restores an analysis.
Type annotations and code completion for boto3.client("quicksight").restore_analysis
method.
boto3 documentation
def restore_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> RestoreAnalysisResponseTypeDef: # (1)
...
kwargs: RestoreAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.restore_analysis(**kwargs)
search_analyses
Searches for analyses that belong to the user specified in the filter.
Type annotations and code completion for boto3.client("quicksight").search_analyses
method.
boto3 documentation
def search_analyses(
self,
*,
AwsAccountId: str,
Filters: Sequence[AnalysisSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchAnalysesResponseTypeDef: # (2)
...
kwargs: SearchAnalysesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Filters": ...,
}
parent.search_analyses(**kwargs)
search_dashboards
Searches for dashboards that belong to a user.
Type annotations and code completion for boto3.client("quicksight").search_dashboards
method.
boto3 documentation
def search_dashboards(
self,
*,
AwsAccountId: str,
Filters: Sequence[DashboardSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDashboardsResponseTypeDef: # (2)
...
kwargs: SearchDashboardsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Filters": ...,
}
parent.search_dashboards(**kwargs)
search_data_sets
Use the SearchDataSets
operation to search for datasets that belong to an
account.
Type annotations and code completion for boto3.client("quicksight").search_data_sets
method.
boto3 documentation
def search_data_sets(
self,
*,
AwsAccountId: str,
Filters: Sequence[DataSetSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDataSetsResponseTypeDef: # (2)
...
kwargs: SearchDataSetsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Filters": ...,
}
parent.search_data_sets(**kwargs)
search_data_sources
Use the SearchDataSources
operation to search for data sources that belong to
an account.
Type annotations and code completion for boto3.client("quicksight").search_data_sources
method.
boto3 documentation
def search_data_sources(
self,
*,
AwsAccountId: str,
Filters: Sequence[DataSourceSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDataSourcesResponseTypeDef: # (2)
...
kwargs: SearchDataSourcesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Filters": ...,
}
parent.search_data_sources(**kwargs)
search_folders
Searches the subfolders in a folder.
Type annotations and code completion for boto3.client("quicksight").search_folders
method.
boto3 documentation
def search_folders(
self,
*,
AwsAccountId: str,
Filters: Sequence[FolderSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchFoldersResponseTypeDef: # (2)
...
kwargs: SearchFoldersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Filters": ...,
}
parent.search_folders(**kwargs)
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 boto3.client("quicksight").search_groups
method.
boto3 documentation
def search_groups(
self,
*,
AwsAccountId: str,
Namespace: str,
Filters: Sequence[GroupSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchGroupsResponseTypeDef: # (2)
...
kwargs: SearchGroupsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"Filters": ...,
}
parent.search_groups(**kwargs)
tag_resource
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
Type annotations and code completion for boto3.client("quicksight").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> TagResourceResponseTypeDef: # (2)
...
- See TagTypeDef
- See TagResourceResponseTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag or tags from a resource.
Type annotations and code completion for boto3.client("quicksight").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> UntagResourceResponseTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_account_customization
Updates Amazon QuickSight customizations for the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").update_account_customization
method.
boto3 documentation
def update_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
) -> UpdateAccountCustomizationResponseTypeDef: # (2)
...
kwargs: UpdateAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AccountCustomization": ...,
}
parent.update_account_customization(**kwargs)
update_account_settings
Updates the Amazon QuickSight settings in your Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").update_account_settings
method.
boto3 documentation
def update_account_settings(
self,
*,
AwsAccountId: str,
DefaultNamespace: str,
NotificationEmail: str = ...,
TerminationProtectionEnabled: bool = ...,
) -> UpdateAccountSettingsResponseTypeDef: # (1)
...
kwargs: UpdateAccountSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DefaultNamespace": ...,
}
parent.update_account_settings(**kwargs)
update_analysis
Updates an analysis in Amazon QuickSight See also: AWS API Documentation.
Type annotations and code completion for boto3.client("quicksight").update_analysis
method.
boto3 documentation
def update_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
SourceEntity: AnalysisSourceEntityTypeDef = ..., # (2)
ThemeArn: str = ...,
Definition: AnalysisDefinitionTypeDef = ..., # (3)
) -> UpdateAnalysisResponseTypeDef: # (4)
...
- See ParametersTypeDef
- See AnalysisSourceEntityTypeDef
- See AnalysisDefinitionTypeDef
- See UpdateAnalysisResponseTypeDef
kwargs: UpdateAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
"Name": ...,
}
parent.update_analysis(**kwargs)
update_analysis_permissions
Updates the read and write permissions for an analysis.
Type annotations and code completion for boto3.client("quicksight").update_analysis_permissions
method.
boto3 documentation
def update_analysis_permissions(
self,
*,
AwsAccountId: str,
AnalysisId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateAnalysisPermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateAnalysisPermissionsResponseTypeDef
kwargs: UpdateAnalysisPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.update_analysis_permissions(**kwargs)
update_dashboard
Updates a dashboard in an Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").update_dashboard
method.
boto3 documentation
def update_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
Name: str,
SourceEntity: DashboardSourceEntityTypeDef = ..., # (1)
Parameters: ParametersTypeDef = ..., # (2)
VersionDescription: str = ...,
DashboardPublishOptions: DashboardPublishOptionsTypeDef = ..., # (3)
ThemeArn: str = ...,
Definition: DashboardVersionDefinitionTypeDef = ..., # (4)
) -> UpdateDashboardResponseTypeDef: # (5)
...
- See DashboardSourceEntityTypeDef
- See ParametersTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See UpdateDashboardResponseTypeDef
kwargs: UpdateDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"Name": ...,
}
parent.update_dashboard(**kwargs)
update_dashboard_permissions
Updates read and write permissions on a dashboard.
Type annotations and code completion for boto3.client("quicksight").update_dashboard_permissions
method.
boto3 documentation
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)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateDashboardPermissionsResponseTypeDef
kwargs: UpdateDashboardPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.update_dashboard_permissions(**kwargs)
update_dashboard_published_version
Updates the published version of a dashboard.
Type annotations and code completion for boto3.client("quicksight").update_dashboard_published_version
method.
boto3 documentation
def update_dashboard_published_version(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int,
) -> UpdateDashboardPublishedVersionResponseTypeDef: # (1)
...
kwargs: UpdateDashboardPublishedVersionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"VersionNumber": ...,
}
parent.update_dashboard_published_version(**kwargs)
update_data_set
Updates a dataset.
Type annotations and code completion for boto3.client("quicksight").update_data_set
method.
boto3 documentation
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)
...
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See DataSetUsageConfigurationTypeDef
- See UpdateDataSetResponseTypeDef
kwargs: UpdateDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"Name": ...,
"PhysicalTableMap": ...,
"ImportMode": ...,
}
parent.update_data_set(**kwargs)
update_data_set_permissions
Updates the permissions on a dataset.
Type annotations and code completion for boto3.client("quicksight").update_data_set_permissions
method.
boto3 documentation
def update_data_set_permissions(
self,
*,
AwsAccountId: str,
DataSetId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateDataSetPermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateDataSetPermissionsResponseTypeDef
kwargs: UpdateDataSetPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.update_data_set_permissions(**kwargs)
update_data_source
Updates a data source.
Type annotations and code completion for boto3.client("quicksight").update_data_source
method.
boto3 documentation
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)
...
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See UpdateDataSourceResponseTypeDef
kwargs: UpdateDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
"Name": ...,
}
parent.update_data_source(**kwargs)
update_data_source_permissions
Updates the permissions to a data source.
Type annotations and code completion for boto3.client("quicksight").update_data_source_permissions
method.
boto3 documentation
def update_data_source_permissions(
self,
*,
AwsAccountId: str,
DataSourceId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateDataSourcePermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateDataSourcePermissionsResponseTypeDef
kwargs: UpdateDataSourcePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.update_data_source_permissions(**kwargs)
update_folder
Updates the name of a folder.
Type annotations and code completion for boto3.client("quicksight").update_folder
method.
boto3 documentation
def update_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
Name: str,
) -> UpdateFolderResponseTypeDef: # (1)
...
kwargs: UpdateFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"Name": ...,
}
parent.update_folder(**kwargs)
update_folder_permissions
Updates permissions of a folder.
Type annotations and code completion for boto3.client("quicksight").update_folder_permissions
method.
boto3 documentation
def update_folder_permissions(
self,
*,
AwsAccountId: str,
FolderId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateFolderPermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateFolderPermissionsResponseTypeDef
kwargs: UpdateFolderPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.update_folder_permissions(**kwargs)
update_group
Changes a group description.
Type annotations and code completion for boto3.client("quicksight").update_group
method.
boto3 documentation
def update_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: str = ...,
) -> UpdateGroupResponseTypeDef: # (1)
...
kwargs: UpdateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.update_group(**kwargs)
update_iam_policy_assignment
Updates an existing IAM policy assignment.
Type annotations and code completion for boto3.client("quicksight").update_iam_policy_assignment
method.
boto3 documentation
def update_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
AssignmentStatus: AssignmentStatusType = ..., # (1)
PolicyArn: str = ...,
Identities: Mapping[str, Sequence[str]] = ...,
) -> UpdateIAMPolicyAssignmentResponseTypeDef: # (2)
...
kwargs: UpdateIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.update_iam_policy_assignment(**kwargs)
update_ip_restriction
Updates the content and status of IP rules.
Type annotations and code completion for boto3.client("quicksight").update_ip_restriction
method.
boto3 documentation
def update_ip_restriction(
self,
*,
AwsAccountId: str,
IpRestrictionRuleMap: Mapping[str, str] = ...,
Enabled: bool = ...,
) -> UpdateIpRestrictionResponseTypeDef: # (1)
...
kwargs: UpdateIpRestrictionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.update_ip_restriction(**kwargs)
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 boto3.client("quicksight").update_public_sharing_settings
method.
boto3 documentation
def update_public_sharing_settings(
self,
*,
AwsAccountId: str,
PublicSharingEnabled: bool = ...,
) -> UpdatePublicSharingSettingsResponseTypeDef: # (1)
...
kwargs: UpdatePublicSharingSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.update_public_sharing_settings(**kwargs)
update_template
Updates a template from an existing Amazon QuickSight analysis or another template.
Type annotations and code completion for boto3.client("quicksight").update_template
method.
boto3 documentation
def update_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
SourceEntity: TemplateSourceEntityTypeDef = ..., # (1)
VersionDescription: str = ...,
Name: str = ...,
Definition: TemplateVersionDefinitionTypeDef = ..., # (2)
) -> UpdateTemplateResponseTypeDef: # (3)
...
- See TemplateSourceEntityTypeDef
- See TemplateVersionDefinitionTypeDef
- See UpdateTemplateResponseTypeDef
kwargs: UpdateTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.update_template(**kwargs)
update_template_alias
Updates the template alias of a template.
Type annotations and code completion for boto3.client("quicksight").update_template_alias
method.
boto3 documentation
def update_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
) -> UpdateTemplateAliasResponseTypeDef: # (1)
...
kwargs: UpdateTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
"TemplateVersionNumber": ...,
}
parent.update_template_alias(**kwargs)
update_template_permissions
Updates the resource permissions for a template.
Type annotations and code completion for boto3.client("quicksight").update_template_permissions
method.
boto3 documentation
def update_template_permissions(
self,
*,
AwsAccountId: str,
TemplateId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateTemplatePermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateTemplatePermissionsResponseTypeDef
kwargs: UpdateTemplatePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.update_template_permissions(**kwargs)
update_theme
Updates a theme.
Type annotations and code completion for boto3.client("quicksight").update_theme
method.
boto3 documentation
def update_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
BaseThemeId: str,
Name: str = ...,
VersionDescription: str = ...,
Configuration: ThemeConfigurationTypeDef = ..., # (1)
) -> UpdateThemeResponseTypeDef: # (2)
...
kwargs: UpdateThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"BaseThemeId": ...,
}
parent.update_theme(**kwargs)
update_theme_alias
Updates an alias of a theme.
Type annotations and code completion for boto3.client("quicksight").update_theme_alias
method.
boto3 documentation
def update_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
) -> UpdateThemeAliasResponseTypeDef: # (1)
...
kwargs: UpdateThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
"ThemeVersionNumber": ...,
}
parent.update_theme_alias(**kwargs)
update_theme_permissions
Updates the resource permissions for a theme.
Type annotations and code completion for boto3.client("quicksight").update_theme_permissions
method.
boto3 documentation
def update_theme_permissions(
self,
*,
AwsAccountId: str,
ThemeId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateThemePermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateThemePermissionsResponseTypeDef
kwargs: UpdateThemePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.update_theme_permissions(**kwargs)
update_user
Updates an Amazon QuickSight user.
Type annotations and code completion for boto3.client("quicksight").update_user
method.
boto3 documentation
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)
...
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
"Email": ...,
"Role": ...,
}
parent.update_user(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("quicksight").get_paginator
method with overloads.
client.get_paginator("list_analyses")
-> ListAnalysesPaginatorclient.get_paginator("list_dashboard_versions")
-> ListDashboardVersionsPaginatorclient.get_paginator("list_dashboards")
-> ListDashboardsPaginatorclient.get_paginator("list_data_sets")
-> ListDataSetsPaginatorclient.get_paginator("list_data_sources")
-> ListDataSourcesPaginatorclient.get_paginator("list_ingestions")
-> ListIngestionsPaginatorclient.get_paginator("list_namespaces")
-> ListNamespacesPaginatorclient.get_paginator("list_template_aliases")
-> ListTemplateAliasesPaginatorclient.get_paginator("list_template_versions")
-> ListTemplateVersionsPaginatorclient.get_paginator("list_templates")
-> ListTemplatesPaginatorclient.get_paginator("list_theme_versions")
-> ListThemeVersionsPaginatorclient.get_paginator("list_themes")
-> ListThemesPaginatorclient.get_paginator("search_analyses")
-> SearchAnalysesPaginatorclient.get_paginator("search_dashboards")
-> SearchDashboardsPaginatorclient.get_paginator("search_data_sets")
-> SearchDataSetsPaginatorclient.get_paginator("search_data_sources")
-> SearchDataSourcesPaginator