QuickSightClient#
Index > QuickSight > QuickSightClient
Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.
QuickSightClient#
Type annotations and code completion for boto3.client("quicksight")
.
boto3 documentation
# QuickSightClient usage example
from boto3.session import Session
from mypy_boto3_quicksight.client import QuickSightClient
def get_quicksight_client() -> QuickSightClient:
return Session().client("quicksight")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("quicksight").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("quicksight")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConcurrentUpdatingException,
client.exceptions.ConflictException,
client.exceptions.CustomerManagedKeyUnavailableException,
client.exceptions.DomainNotWhitelistedException,
client.exceptions.IdentityTypeNotSupportedException,
client.exceptions.InternalFailureException,
client.exceptions.InternalServerException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.PreconditionNotMetException,
client.exceptions.QuickSightUserNotFoundException,
client.exceptions.ResourceExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceUnavailableException,
client.exceptions.SessionLifetimeInMinutesInvalidException,
client.exceptions.ThrottlingException,
client.exceptions.UnsupportedPricingPlanException,
client.exceptions.UnsupportedUserEditionException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_quicksight.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
batch_create_topic_reviewed_answer#
Creates new reviewed answers for a Q Topic.
Type annotations and code completion for boto3.client("quicksight").batch_create_topic_reviewed_answer
method.
boto3 documentation
# batch_create_topic_reviewed_answer method definition
def batch_create_topic_reviewed_answer(
self,
*,
AwsAccountId: str,
TopicId: str,
Answers: Sequence[CreateTopicReviewedAnswerTypeDef], # (1)
) -> BatchCreateTopicReviewedAnswerResponseTypeDef: # (2)
...
# batch_create_topic_reviewed_answer method usage example with argument unpacking
kwargs: BatchCreateTopicReviewedAnswerRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"Answers": ...,
}
parent.batch_create_topic_reviewed_answer(**kwargs)
batch_delete_topic_reviewed_answer#
Deletes reviewed answers for Q Topic.
Type annotations and code completion for boto3.client("quicksight").batch_delete_topic_reviewed_answer
method.
boto3 documentation
# batch_delete_topic_reviewed_answer method definition
def batch_delete_topic_reviewed_answer(
self,
*,
AwsAccountId: str,
TopicId: str,
AnswerIds: Sequence[str] = ...,
) -> BatchDeleteTopicReviewedAnswerResponseTypeDef: # (1)
...
# batch_delete_topic_reviewed_answer method usage example with argument unpacking
kwargs: BatchDeleteTopicReviewedAnswerRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.batch_delete_topic_reviewed_answer(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("quicksight").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_ingestion#
Cancels an ongoing ingestion of data into SPICE.
Type annotations and code completion for boto3.client("quicksight").cancel_ingestion
method.
boto3 documentation
# cancel_ingestion method definition
def cancel_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> CancelIngestionResponseTypeDef: # (1)
...
# cancel_ingestion method usage example with argument unpacking
kwargs: CancelIngestionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"IngestionId": ...,
}
parent.cancel_ingestion(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("quicksight").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_account_customization#
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").create_account_customization
method.
boto3 documentation
# create_account_customization method definition
def create_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAccountCustomizationResponseTypeDef: # (3)
...
# create_account_customization method usage example with argument unpacking
kwargs: CreateAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AccountCustomization": ...,
}
parent.create_account_customization(**kwargs)
create_account_subscription#
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
Type annotations and code completion for boto3.client("quicksight").create_account_subscription
method.
boto3 documentation
# create_account_subscription method definition
def create_account_subscription(
self,
*,
AuthenticationMethod: AuthenticationMethodOptionType, # (1)
AwsAccountId: str,
AccountName: str,
NotificationEmail: str,
Edition: EditionType = ..., # (2)
ActiveDirectoryName: str = ...,
Realm: str = ...,
DirectoryId: str = ...,
AdminGroup: Sequence[str] = ...,
AuthorGroup: Sequence[str] = ...,
ReaderGroup: Sequence[str] = ...,
AdminProGroup: Sequence[str] = ...,
AuthorProGroup: Sequence[str] = ...,
ReaderProGroup: Sequence[str] = ...,
FirstName: str = ...,
LastName: str = ...,
EmailAddress: str = ...,
ContactNumber: str = ...,
IAMIdentityCenterInstanceArn: str = ...,
) -> CreateAccountSubscriptionResponseTypeDef: # (3)
...
# create_account_subscription method usage example with argument unpacking
kwargs: CreateAccountSubscriptionRequestRequestTypeDef = { # (1)
"AuthenticationMethod": ...,
"AwsAccountId": ...,
"AccountName": ...,
"NotificationEmail": ...,
}
parent.create_account_subscription(**kwargs)
create_analysis#
Creates an analysis in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_analysis
method.
boto3 documentation
# create_analysis method definition
def create_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionUnionTypeDef] = ..., # (2)
SourceEntity: AnalysisSourceEntityTypeDef = ..., # (3)
ThemeArn: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
Definition: AnalysisDefinitionTypeDef = ..., # (5)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (6)
FolderArns: Sequence[str] = ...,
) -> CreateAnalysisResponseTypeDef: # (7)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef ResourcePermissionOutputTypeDef
- See AnalysisSourceEntityTypeDef
- See TagTypeDef
- See AnalysisDefinitionTypeDef
- See ValidationStrategyTypeDef
- See CreateAnalysisResponseTypeDef
# create_analysis method usage example with argument unpacking
kwargs: CreateAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
"Name": ...,
}
parent.create_analysis(**kwargs)
create_brand#
Creates an Amazon QuickSight brand.
Type annotations and code completion for boto3.client("quicksight").create_brand
method.
boto3 documentation
# create_brand method definition
def create_brand(
self,
*,
AwsAccountId: str,
BrandId: str,
BrandDefinition: BrandDefinitionTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateBrandResponseTypeDef: # (3)
...
# create_brand method usage example with argument unpacking
kwargs: CreateBrandRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
}
parent.create_brand(**kwargs)
create_custom_permissions#
Creates a custom permissions profile.
Type annotations and code completion for boto3.client("quicksight").create_custom_permissions
method.
boto3 documentation
# create_custom_permissions method definition
def create_custom_permissions(
self,
*,
AwsAccountId: str,
CustomPermissionsName: str,
Capabilities: CapabilitiesTypeDef = ..., # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateCustomPermissionsResponseTypeDef: # (3)
...
# create_custom_permissions method usage example with argument unpacking
kwargs: CreateCustomPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"CustomPermissionsName": ...,
}
parent.create_custom_permissions(**kwargs)
create_dashboard#
Creates a dashboard from either a template or directly with a
DashboardDefinition
.
Type annotations and code completion for boto3.client("quicksight").create_dashboard
method.
boto3 documentation
# create_dashboard method definition
def create_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
SourceEntity: DashboardSourceEntityTypeDef = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
VersionDescription: str = ...,
DashboardPublishOptions: DashboardPublishOptionsTypeDef = ..., # (5)
ThemeArn: str = ...,
Definition: DashboardVersionDefinitionTypeDef = ..., # (6)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (7)
FolderArns: Sequence[str] = ...,
LinkSharingConfiguration: LinkSharingConfigurationTypeDef = ..., # (8)
LinkEntities: Sequence[str] = ...,
) -> CreateDashboardResponseTypeDef: # (9)
...
- See ParametersTypeDef
- See ResourcePermissionTypeDef
- See DashboardSourceEntityTypeDef
- See TagTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
- See LinkSharingConfigurationTypeDef
- See CreateDashboardResponseTypeDef
# create_dashboard method usage example with argument unpacking
kwargs: CreateDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"Name": ...,
}
parent.create_dashboard(**kwargs)
create_data_set#
Creates a dataset.
Type annotations and code completion for boto3.client("quicksight").create_data_set
method.
boto3 documentation
# create_data_set method definition
def create_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
Name: str,
PhysicalTableMap: Mapping[str, PhysicalTableUnionTypeDef], # (1)
ImportMode: DataSetImportModeType, # (2)
LogicalTableMap: Mapping[str, LogicalTableUnionTypeDef] = ..., # (3)
ColumnGroups: Sequence[ColumnGroupUnionTypeDef] = ..., # (4)
FieldFolders: Mapping[str, FieldFolderUnionTypeDef] = ..., # (5)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (6)
RowLevelPermissionDataSet: RowLevelPermissionDataSetTypeDef = ..., # (7)
RowLevelPermissionTagConfiguration: RowLevelPermissionTagConfigurationTypeDef = ..., # (8)
ColumnLevelPermissionRules: Sequence[ColumnLevelPermissionRuleUnionTypeDef] = ..., # (9)
Tags: Sequence[TagTypeDef] = ..., # (10)
DataSetUsageConfiguration: DataSetUsageConfigurationTypeDef = ..., # (11)
DatasetParameters: Sequence[DatasetParameterUnionTypeDef] = ..., # (12)
FolderArns: Sequence[str] = ...,
) -> CreateDataSetResponseTypeDef: # (13)
...
- See PhysicalTableTypeDef PhysicalTableOutputTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef LogicalTableOutputTypeDef
- See ColumnGroupTypeDef ColumnGroupOutputTypeDef
- See FieldFolderTypeDef FieldFolderOutputTypeDef
- See ResourcePermissionTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef ColumnLevelPermissionRuleOutputTypeDef
- See TagTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef DatasetParameterOutputTypeDef
- See CreateDataSetResponseTypeDef
# create_data_set method usage example with argument unpacking
kwargs: CreateDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"Name": ...,
"PhysicalTableMap": ...,
"ImportMode": ...,
}
parent.create_data_set(**kwargs)
create_data_source#
Creates a data source.
Type annotations and code completion for boto3.client("quicksight").create_data_source
method.
boto3 documentation
# create_data_source method definition
def create_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
Name: str,
Type: DataSourceTypeType, # (1)
DataSourceParameters: DataSourceParametersTypeDef = ..., # (2)
Credentials: DataSourceCredentialsTypeDef = ..., # (3)
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (4)
VpcConnectionProperties: VpcConnectionPropertiesTypeDef = ..., # (5)
SslProperties: SslPropertiesTypeDef = ..., # (6)
Tags: Sequence[TagTypeDef] = ..., # (7)
FolderArns: Sequence[str] = ...,
) -> CreateDataSourceResponseTypeDef: # (8)
...
- See DataSourceTypeType
- See DataSourceParametersTypeDef
- See DataSourceCredentialsTypeDef
- See ResourcePermissionTypeDef
- See VpcConnectionPropertiesTypeDef
- See SslPropertiesTypeDef
- See TagTypeDef
- See CreateDataSourceResponseTypeDef
# create_data_source method usage example with argument unpacking
kwargs: CreateDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
"Name": ...,
"Type": ...,
}
parent.create_data_source(**kwargs)
create_folder#
Creates an empty shared folder.
Type annotations and code completion for boto3.client("quicksight").create_folder
method.
boto3 documentation
# create_folder method definition
def create_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
Name: str = ...,
FolderType: FolderTypeType = ..., # (1)
ParentFolderArn: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
SharingModel: SharingModelType = ..., # (4)
) -> CreateFolderResponseTypeDef: # (5)
...
- See FolderTypeType
- See ResourcePermissionTypeDef
- See TagTypeDef
- See SharingModelType
- See CreateFolderResponseTypeDef
# create_folder method usage example with argument unpacking
kwargs: CreateFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.create_folder(**kwargs)
create_folder_membership#
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
Type annotations and code completion for boto3.client("quicksight").create_folder_membership
method.
boto3 documentation
# create_folder_membership method definition
def create_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> CreateFolderMembershipResponseTypeDef: # (2)
...
# create_folder_membership method usage example with argument unpacking
kwargs: CreateFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.create_folder_membership(**kwargs)
create_group#
Use the CreateGroup
operation to create a group in Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_group
method.
boto3 documentation
# create_group method definition
def create_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: str = ...,
) -> CreateGroupResponseTypeDef: # (1)
...
# create_group method usage example with argument unpacking
kwargs: CreateGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group(**kwargs)
create_group_membership#
Adds an Amazon QuickSight user to an Amazon QuickSight group.
Type annotations and code completion for boto3.client("quicksight").create_group_membership
method.
boto3 documentation
# create_group_membership method definition
def create_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> CreateGroupMembershipResponseTypeDef: # (1)
...
# create_group_membership method usage example with argument unpacking
kwargs: CreateGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.create_group_membership(**kwargs)
create_iam_policy_assignment#
Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN).
Type annotations and code completion for boto3.client("quicksight").create_iam_policy_assignment
method.
boto3 documentation
# create_iam_policy_assignment method definition
def create_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
AssignmentStatus: AssignmentStatusType, # (1)
Namespace: str,
PolicyArn: str = ...,
Identities: Mapping[str, Sequence[str]] = ...,
) -> CreateIAMPolicyAssignmentResponseTypeDef: # (2)
...
# create_iam_policy_assignment method usage example with argument unpacking
kwargs: CreateIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"AssignmentStatus": ...,
"Namespace": ...,
}
parent.create_iam_policy_assignment(**kwargs)
create_ingestion#
Creates and starts a new SPICE ingestion for a dataset.
Type annotations and code completion for boto3.client("quicksight").create_ingestion
method.
boto3 documentation
# create_ingestion method definition
def create_ingestion(
self,
*,
DataSetId: str,
IngestionId: str,
AwsAccountId: str,
IngestionType: IngestionTypeType = ..., # (1)
) -> CreateIngestionResponseTypeDef: # (2)
...
# create_ingestion method usage example with argument unpacking
kwargs: CreateIngestionRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"IngestionId": ...,
"AwsAccountId": ...,
}
parent.create_ingestion(**kwargs)
create_namespace#
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").create_namespace
method.
boto3 documentation
# create_namespace method definition
def create_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
IdentityStore: IdentityStoreType, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateNamespaceResponseTypeDef: # (3)
...
# create_namespace method usage example with argument unpacking
kwargs: CreateNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"IdentityStore": ...,
}
parent.create_namespace(**kwargs)
create_refresh_schedule#
Creates a refresh schedule for a dataset.
Type annotations and code completion for boto3.client("quicksight").create_refresh_schedule
method.
boto3 documentation
# create_refresh_schedule method definition
def create_refresh_schedule(
self,
*,
DataSetId: str,
AwsAccountId: str,
Schedule: RefreshScheduleTypeDef, # (1)
) -> CreateRefreshScheduleResponseTypeDef: # (2)
...
# create_refresh_schedule method usage example with argument unpacking
kwargs: CreateRefreshScheduleRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
"Schedule": ...,
}
parent.create_refresh_schedule(**kwargs)
create_role_membership#
Use CreateRoleMembership
to add an existing Amazon QuickSight group to an
existing role.
Type annotations and code completion for boto3.client("quicksight").create_role_membership
method.
boto3 documentation
# create_role_membership method definition
def create_role_membership(
self,
*,
MemberName: str,
AwsAccountId: str,
Namespace: str,
Role: RoleType, # (1)
) -> CreateRoleMembershipResponseTypeDef: # (2)
...
# create_role_membership method usage example with argument unpacking
kwargs: CreateRoleMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"AwsAccountId": ...,
"Namespace": ...,
"Role": ...,
}
parent.create_role_membership(**kwargs)
create_template#
Creates a template either from a TemplateDefinition
or from an existing
Amazon QuickSight analysis or template.
Type annotations and code completion for boto3.client("quicksight").create_template
method.
boto3 documentation
# create_template method definition
def create_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
Name: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
SourceEntity: TemplateSourceEntityTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
VersionDescription: str = ...,
Definition: TemplateVersionDefinitionTypeDef = ..., # (4)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (5)
) -> CreateTemplateResponseTypeDef: # (6)
...
- See ResourcePermissionTypeDef
- See TemplateSourceEntityTypeDef
- See TagTypeDef
- See TemplateVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
- See CreateTemplateResponseTypeDef
# create_template method usage example with argument unpacking
kwargs: CreateTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.create_template(**kwargs)
create_template_alias#
Creates a template alias for a template.
Type annotations and code completion for boto3.client("quicksight").create_template_alias
method.
boto3 documentation
# create_template_alias method definition
def create_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
) -> CreateTemplateAliasResponseTypeDef: # (1)
...
# create_template_alias method usage example with argument unpacking
kwargs: CreateTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
"TemplateVersionNumber": ...,
}
parent.create_template_alias(**kwargs)
create_theme#
Creates a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme
method.
boto3 documentation
# create_theme method definition
def create_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
Name: str,
BaseThemeId: str,
Configuration: ThemeConfigurationTypeDef, # (1)
VersionDescription: str = ...,
Permissions: Sequence[ResourcePermissionTypeDef] = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> CreateThemeResponseTypeDef: # (4)
...
- See ThemeConfigurationTypeDef
- See ResourcePermissionTypeDef
- See TagTypeDef
- See CreateThemeResponseTypeDef
# create_theme method usage example with argument unpacking
kwargs: CreateThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"Name": ...,
"BaseThemeId": ...,
"Configuration": ...,
}
parent.create_theme(**kwargs)
create_theme_alias#
Creates a theme alias for a theme.
Type annotations and code completion for boto3.client("quicksight").create_theme_alias
method.
boto3 documentation
# create_theme_alias method definition
def create_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
) -> CreateThemeAliasResponseTypeDef: # (1)
...
# create_theme_alias method usage example with argument unpacking
kwargs: CreateThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
"ThemeVersionNumber": ...,
}
parent.create_theme_alias(**kwargs)
create_topic#
Creates a new Q topic.
Type annotations and code completion for boto3.client("quicksight").create_topic
method.
boto3 documentation
# create_topic method definition
def create_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateTopicResponseTypeDef: # (3)
...
- See TopicDetailsTypeDef
- See TagTypeDef
- See CreateTopicResponseTypeDef
# create_topic method usage example with argument unpacking
kwargs: CreateTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"Topic": ...,
}
parent.create_topic(**kwargs)
create_topic_refresh_schedule#
Creates a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").create_topic_refresh_schedule
method.
boto3 documentation
# create_topic_refresh_schedule method definition
def create_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetArn: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
DatasetName: str = ...,
) -> CreateTopicRefreshScheduleResponseTypeDef: # (2)
...
# create_topic_refresh_schedule method usage example with argument unpacking
kwargs: CreateTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetArn": ...,
"RefreshSchedule": ...,
}
parent.create_topic_refresh_schedule(**kwargs)
create_vpc_connection#
Creates a new VPC connection.
Type annotations and code completion for boto3.client("quicksight").create_vpc_connection
method.
boto3 documentation
# create_vpc_connection method definition
def create_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
RoleArn: str,
DnsResolvers: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateVPCConnectionResponseTypeDef: # (2)
...
# create_vpc_connection method usage example with argument unpacking
kwargs: CreateVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
"Name": ...,
"SubnetIds": ...,
"SecurityGroupIds": ...,
"RoleArn": ...,
}
parent.create_vpc_connection(**kwargs)
delete_account_customization#
Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
Type annotations and code completion for boto3.client("quicksight").delete_account_customization
method.
boto3 documentation
# delete_account_customization method definition
def delete_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
) -> DeleteAccountCustomizationResponseTypeDef: # (1)
...
# delete_account_customization method usage example with argument unpacking
kwargs: DeleteAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_customization(**kwargs)
delete_account_subscription#
Use the DeleteAccountSubscription
operation to delete an Amazon QuickSight
account.
Type annotations and code completion for boto3.client("quicksight").delete_account_subscription
method.
boto3 documentation
# delete_account_subscription method definition
def delete_account_subscription(
self,
*,
AwsAccountId: str,
) -> DeleteAccountSubscriptionResponseTypeDef: # (1)
...
# delete_account_subscription method usage example with argument unpacking
kwargs: DeleteAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_account_subscription(**kwargs)
delete_analysis#
Deletes an analysis from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_analysis
method.
boto3 documentation
# delete_analysis method definition
def delete_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
RecoveryWindowInDays: int = ...,
ForceDeleteWithoutRecovery: bool = ...,
) -> DeleteAnalysisResponseTypeDef: # (1)
...
# delete_analysis method usage example with argument unpacking
kwargs: DeleteAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.delete_analysis(**kwargs)
delete_brand#
Deletes an Amazon QuickSight brand.
Type annotations and code completion for boto3.client("quicksight").delete_brand
method.
boto3 documentation
# delete_brand method definition
def delete_brand(
self,
*,
AwsAccountId: str,
BrandId: str,
) -> DeleteBrandResponseTypeDef: # (1)
...
# delete_brand method usage example with argument unpacking
kwargs: DeleteBrandRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
}
parent.delete_brand(**kwargs)
delete_brand_assignment#
Deletes a brand assignment.
Type annotations and code completion for boto3.client("quicksight").delete_brand_assignment
method.
boto3 documentation
# delete_brand_assignment method definition
def delete_brand_assignment(
self,
*,
AwsAccountId: str,
) -> DeleteBrandAssignmentResponseTypeDef: # (1)
...
# delete_brand_assignment method usage example with argument unpacking
kwargs: DeleteBrandAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.delete_brand_assignment(**kwargs)
delete_custom_permissions#
Deletes a custom permissions profile.
Type annotations and code completion for boto3.client("quicksight").delete_custom_permissions
method.
boto3 documentation
# delete_custom_permissions method definition
def delete_custom_permissions(
self,
*,
AwsAccountId: str,
CustomPermissionsName: str,
) -> DeleteCustomPermissionsResponseTypeDef: # (1)
...
# delete_custom_permissions method usage example with argument unpacking
kwargs: DeleteCustomPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"CustomPermissionsName": ...,
}
parent.delete_custom_permissions(**kwargs)
delete_dashboard#
Deletes a dashboard.
Type annotations and code completion for boto3.client("quicksight").delete_dashboard
method.
boto3 documentation
# delete_dashboard method definition
def delete_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
) -> DeleteDashboardResponseTypeDef: # (1)
...
# delete_dashboard method usage example with argument unpacking
kwargs: DeleteDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.delete_dashboard(**kwargs)
delete_data_set#
Deletes a dataset.
Type annotations and code completion for boto3.client("quicksight").delete_data_set
method.
boto3 documentation
# delete_data_set method definition
def delete_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DeleteDataSetResponseTypeDef: # (1)
...
# delete_data_set method usage example with argument unpacking
kwargs: DeleteDataSetRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.delete_data_set(**kwargs)
delete_data_set_refresh_properties#
Deletes the dataset refresh properties of the dataset.
Type annotations and code completion for boto3.client("quicksight").delete_data_set_refresh_properties
method.
boto3 documentation
# delete_data_set_refresh_properties method definition
def delete_data_set_refresh_properties(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DeleteDataSetRefreshPropertiesResponseTypeDef: # (1)
...
# delete_data_set_refresh_properties method usage example with argument unpacking
kwargs: DeleteDataSetRefreshPropertiesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.delete_data_set_refresh_properties(**kwargs)
delete_data_source#
Deletes the data source permanently.
Type annotations and code completion for boto3.client("quicksight").delete_data_source
method.
boto3 documentation
# delete_data_source method definition
def delete_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DeleteDataSourceResponseTypeDef: # (1)
...
# delete_data_source method usage example with argument unpacking
kwargs: DeleteDataSourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSourceId": ...,
}
parent.delete_data_source(**kwargs)
delete_folder#
Deletes an empty folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder
method.
boto3 documentation
# delete_folder method definition
def delete_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DeleteFolderResponseTypeDef: # (1)
...
# delete_folder method usage example with argument unpacking
kwargs: DeleteFolderRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
}
parent.delete_folder(**kwargs)
delete_folder_membership#
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Type annotations and code completion for boto3.client("quicksight").delete_folder_membership
method.
boto3 documentation
# delete_folder_membership method definition
def delete_folder_membership(
self,
*,
AwsAccountId: str,
FolderId: str,
MemberId: str,
MemberType: MemberTypeType, # (1)
) -> DeleteFolderMembershipResponseTypeDef: # (2)
...
# delete_folder_membership method usage example with argument unpacking
kwargs: DeleteFolderMembershipRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"FolderId": ...,
"MemberId": ...,
"MemberType": ...,
}
parent.delete_folder_membership(**kwargs)
delete_group#
Removes a user group from Amazon QuickSight.
Type annotations and code completion for boto3.client("quicksight").delete_group
method.
boto3 documentation
# delete_group method definition
def delete_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupResponseTypeDef: # (1)
...
# delete_group method usage example with argument unpacking
kwargs: DeleteGroupRequestRequestTypeDef = { # (1)
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group(**kwargs)
delete_group_membership#
Removes a user from a group so that the user is no longer a member of the group.
Type annotations and code completion for boto3.client("quicksight").delete_group_membership
method.
boto3 documentation
# delete_group_membership method definition
def delete_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteGroupMembershipResponseTypeDef: # (1)
...
# delete_group_membership method usage example with argument unpacking
kwargs: DeleteGroupMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"GroupName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_group_membership(**kwargs)
delete_iam_policy_assignment#
Deletes an existing IAM policy assignment.
Type annotations and code completion for boto3.client("quicksight").delete_iam_policy_assignment
method.
boto3 documentation
# delete_iam_policy_assignment method definition
def delete_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
) -> DeleteIAMPolicyAssignmentResponseTypeDef: # (1)
...
# delete_iam_policy_assignment method usage example with argument unpacking
kwargs: DeleteIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.delete_iam_policy_assignment(**kwargs)
delete_identity_propagation_config#
Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.
Type annotations and code completion for boto3.client("quicksight").delete_identity_propagation_config
method.
boto3 documentation
# delete_identity_propagation_config method definition
def delete_identity_propagation_config(
self,
*,
AwsAccountId: str,
Service: ServiceTypeType, # (1)
) -> DeleteIdentityPropagationConfigResponseTypeDef: # (2)
...
# delete_identity_propagation_config method usage example with argument unpacking
kwargs: DeleteIdentityPropagationConfigRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Service": ...,
}
parent.delete_identity_propagation_config(**kwargs)
delete_namespace#
Deletes a namespace and the users and groups that are associated with the namespace.
Type annotations and code completion for boto3.client("quicksight").delete_namespace
method.
boto3 documentation
# delete_namespace method definition
def delete_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
) -> DeleteNamespaceResponseTypeDef: # (1)
...
# delete_namespace method usage example with argument unpacking
kwargs: DeleteNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_namespace(**kwargs)
delete_refresh_schedule#
Deletes a refresh schedule from a dataset.
Type annotations and code completion for boto3.client("quicksight").delete_refresh_schedule
method.
boto3 documentation
# delete_refresh_schedule method definition
def delete_refresh_schedule(
self,
*,
DataSetId: str,
AwsAccountId: str,
ScheduleId: str,
) -> DeleteRefreshScheduleResponseTypeDef: # (1)
...
# delete_refresh_schedule method usage example with argument unpacking
kwargs: DeleteRefreshScheduleRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
"ScheduleId": ...,
}
parent.delete_refresh_schedule(**kwargs)
delete_role_custom_permission#
Removes custom permissions from the role.
Type annotations and code completion for boto3.client("quicksight").delete_role_custom_permission
method.
boto3 documentation
# delete_role_custom_permission method definition
def delete_role_custom_permission(
self,
*,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
) -> DeleteRoleCustomPermissionResponseTypeDef: # (2)
...
# delete_role_custom_permission method usage example with argument unpacking
kwargs: DeleteRoleCustomPermissionRequestRequestTypeDef = { # (1)
"Role": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_role_custom_permission(**kwargs)
delete_role_membership#
Removes a group from a role.
Type annotations and code completion for boto3.client("quicksight").delete_role_membership
method.
boto3 documentation
# delete_role_membership method definition
def delete_role_membership(
self,
*,
MemberName: str,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
) -> DeleteRoleMembershipResponseTypeDef: # (2)
...
# delete_role_membership method usage example with argument unpacking
kwargs: DeleteRoleMembershipRequestRequestTypeDef = { # (1)
"MemberName": ...,
"Role": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_role_membership(**kwargs)
delete_template#
Deletes a template.
Type annotations and code completion for boto3.client("quicksight").delete_template
method.
boto3 documentation
# delete_template method definition
def delete_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
) -> DeleteTemplateResponseTypeDef: # (1)
...
# delete_template method usage example with argument unpacking
kwargs: DeleteTemplateRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
}
parent.delete_template(**kwargs)
delete_template_alias#
Deletes the item that the specified template alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_template_alias
method.
boto3 documentation
# delete_template_alias method definition
def delete_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
) -> DeleteTemplateAliasResponseTypeDef: # (1)
...
# delete_template_alias method usage example with argument unpacking
kwargs: DeleteTemplateAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TemplateId": ...,
"AliasName": ...,
}
parent.delete_template_alias(**kwargs)
delete_theme#
Deletes a theme.
Type annotations and code completion for boto3.client("quicksight").delete_theme
method.
boto3 documentation
# delete_theme method definition
def delete_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
VersionNumber: int = ...,
) -> DeleteThemeResponseTypeDef: # (1)
...
# delete_theme method usage example with argument unpacking
kwargs: DeleteThemeRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.delete_theme(**kwargs)
delete_theme_alias#
Deletes the version of the theme that the specified theme alias points to.
Type annotations and code completion for boto3.client("quicksight").delete_theme_alias
method.
boto3 documentation
# delete_theme_alias method definition
def delete_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
) -> DeleteThemeAliasResponseTypeDef: # (1)
...
# delete_theme_alias method usage example with argument unpacking
kwargs: DeleteThemeAliasRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
"AliasName": ...,
}
parent.delete_theme_alias(**kwargs)
delete_topic#
Deletes a topic.
Type annotations and code completion for boto3.client("quicksight").delete_topic
method.
boto3 documentation
# delete_topic method definition
def delete_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> DeleteTopicResponseTypeDef: # (1)
...
# delete_topic method usage example with argument unpacking
kwargs: DeleteTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.delete_topic(**kwargs)
delete_topic_refresh_schedule#
Deletes a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").delete_topic_refresh_schedule
method.
boto3 documentation
# delete_topic_refresh_schedule method definition
def delete_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetId: str,
) -> DeleteTopicRefreshScheduleResponseTypeDef: # (1)
...
# delete_topic_refresh_schedule method usage example with argument unpacking
kwargs: DeleteTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetId": ...,
}
parent.delete_topic_refresh_schedule(**kwargs)
delete_user#
Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call.
Type annotations and code completion for boto3.client("quicksight").delete_user
method.
boto3 documentation
# delete_user method definition
def delete_user(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserResponseTypeDef: # (1)
...
# delete_user method usage example with argument unpacking
kwargs: DeleteUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user(**kwargs)
delete_user_by_principal_id#
Deletes a user identified by its principal ID.
Type annotations and code completion for boto3.client("quicksight").delete_user_by_principal_id
method.
boto3 documentation
# delete_user_by_principal_id method definition
def delete_user_by_principal_id(
self,
*,
PrincipalId: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserByPrincipalIdResponseTypeDef: # (1)
...
# delete_user_by_principal_id method usage example with argument unpacking
kwargs: DeleteUserByPrincipalIdRequestRequestTypeDef = { # (1)
"PrincipalId": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user_by_principal_id(**kwargs)
delete_user_custom_permission#
Deletes a custom permissions profile from a user.
Type annotations and code completion for boto3.client("quicksight").delete_user_custom_permission
method.
boto3 documentation
# delete_user_custom_permission method definition
def delete_user_custom_permission(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DeleteUserCustomPermissionResponseTypeDef: # (1)
...
# delete_user_custom_permission method usage example with argument unpacking
kwargs: DeleteUserCustomPermissionRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.delete_user_custom_permission(**kwargs)
delete_vpc_connection#
Deletes a VPC connection.
Type annotations and code completion for boto3.client("quicksight").delete_vpc_connection
method.
boto3 documentation
# delete_vpc_connection method definition
def delete_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
) -> DeleteVPCConnectionResponseTypeDef: # (1)
...
# delete_vpc_connection method usage example with argument unpacking
kwargs: DeleteVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
}
parent.delete_vpc_connection(**kwargs)
describe_account_customization#
Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").describe_account_customization
method.
boto3 documentation
# describe_account_customization method definition
def describe_account_customization(
self,
*,
AwsAccountId: str,
Namespace: str = ...,
Resolved: bool = ...,
) -> DescribeAccountCustomizationResponseTypeDef: # (1)
...
# describe_account_customization method usage example with argument unpacking
kwargs: DescribeAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_customization(**kwargs)
describe_account_settings#
Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").describe_account_settings
method.
boto3 documentation
# describe_account_settings method definition
def describe_account_settings(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSettingsResponseTypeDef: # (1)
...
# describe_account_settings method usage example with argument unpacking
kwargs: DescribeAccountSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_settings(**kwargs)
describe_account_subscription#
Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription.
Type annotations and code completion for boto3.client("quicksight").describe_account_subscription
method.
boto3 documentation
# describe_account_subscription method definition
def describe_account_subscription(
self,
*,
AwsAccountId: str,
) -> DescribeAccountSubscriptionResponseTypeDef: # (1)
...
# describe_account_subscription method usage example with argument unpacking
kwargs: DescribeAccountSubscriptionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_account_subscription(**kwargs)
describe_analysis#
Provides a summary of the metadata for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis
method.
boto3 documentation
# describe_analysis method definition
def describe_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisResponseTypeDef: # (1)
...
# describe_analysis method usage example with argument unpacking
kwargs: DescribeAnalysisRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis(**kwargs)
describe_analysis_definition#
Provides a detailed description of the definition of an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_definition
method.
boto3 documentation
# describe_analysis_definition method definition
def describe_analysis_definition(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisDefinitionResponseTypeDef: # (1)
...
# describe_analysis_definition method usage example with argument unpacking
kwargs: DescribeAnalysisDefinitionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_definition(**kwargs)
describe_analysis_permissions#
Provides the read and write permissions for an analysis.
Type annotations and code completion for boto3.client("quicksight").describe_analysis_permissions
method.
boto3 documentation
# describe_analysis_permissions method definition
def describe_analysis_permissions(
self,
*,
AwsAccountId: str,
AnalysisId: str,
) -> DescribeAnalysisPermissionsResponseTypeDef: # (1)
...
# describe_analysis_permissions method usage example with argument unpacking
kwargs: DescribeAnalysisPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.describe_analysis_permissions(**kwargs)
describe_asset_bundle_export_job#
Describes an existing export job.
Type annotations and code completion for boto3.client("quicksight").describe_asset_bundle_export_job
method.
boto3 documentation
# describe_asset_bundle_export_job method definition
def describe_asset_bundle_export_job(
self,
*,
AwsAccountId: str,
AssetBundleExportJobId: str,
) -> DescribeAssetBundleExportJobResponseTypeDef: # (1)
...
# describe_asset_bundle_export_job method usage example with argument unpacking
kwargs: DescribeAssetBundleExportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleExportJobId": ...,
}
parent.describe_asset_bundle_export_job(**kwargs)
describe_asset_bundle_import_job#
Describes an existing import job.
Type annotations and code completion for boto3.client("quicksight").describe_asset_bundle_import_job
method.
boto3 documentation
# describe_asset_bundle_import_job method definition
def describe_asset_bundle_import_job(
self,
*,
AwsAccountId: str,
AssetBundleImportJobId: str,
) -> DescribeAssetBundleImportJobResponseTypeDef: # (1)
...
# describe_asset_bundle_import_job method usage example with argument unpacking
kwargs: DescribeAssetBundleImportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleImportJobId": ...,
}
parent.describe_asset_bundle_import_job(**kwargs)
describe_brand#
Describes a brand.
Type annotations and code completion for boto3.client("quicksight").describe_brand
method.
boto3 documentation
# describe_brand method definition
def describe_brand(
self,
*,
AwsAccountId: str,
BrandId: str,
VersionId: str = ...,
) -> DescribeBrandResponseTypeDef: # (1)
...
# describe_brand method usage example with argument unpacking
kwargs: DescribeBrandRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
}
parent.describe_brand(**kwargs)
describe_brand_assignment#
Describes a brand assignment.
Type annotations and code completion for boto3.client("quicksight").describe_brand_assignment
method.
boto3 documentation
# describe_brand_assignment method definition
def describe_brand_assignment(
self,
*,
AwsAccountId: str,
) -> DescribeBrandAssignmentResponseTypeDef: # (1)
...
# describe_brand_assignment method usage example with argument unpacking
kwargs: DescribeBrandAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_brand_assignment(**kwargs)
describe_brand_published_version#
Describes the published version of the brand.
Type annotations and code completion for boto3.client("quicksight").describe_brand_published_version
method.
boto3 documentation
# describe_brand_published_version method definition
def describe_brand_published_version(
self,
*,
AwsAccountId: str,
BrandId: str,
) -> DescribeBrandPublishedVersionResponseTypeDef: # (1)
...
# describe_brand_published_version method usage example with argument unpacking
kwargs: DescribeBrandPublishedVersionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
}
parent.describe_brand_published_version(**kwargs)
describe_custom_permissions#
Describes a custom permissions profile.
Type annotations and code completion for boto3.client("quicksight").describe_custom_permissions
method.
boto3 documentation
# describe_custom_permissions method definition
def describe_custom_permissions(
self,
*,
AwsAccountId: str,
CustomPermissionsName: str,
) -> DescribeCustomPermissionsResponseTypeDef: # (1)
...
# describe_custom_permissions method usage example with argument unpacking
kwargs: DescribeCustomPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"CustomPermissionsName": ...,
}
parent.describe_custom_permissions(**kwargs)
describe_dashboard#
Provides a summary for a dashboard.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard
method.
boto3 documentation
# describe_dashboard method definition
def describe_dashboard(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeDashboardResponseTypeDef: # (1)
...
# describe_dashboard method usage example with argument unpacking
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
# describe_dashboard_definition method definition
def describe_dashboard_definition(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeDashboardDefinitionResponseTypeDef: # (1)
...
# describe_dashboard_definition method usage example with argument unpacking
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
# describe_dashboard_permissions method definition
def describe_dashboard_permissions(
self,
*,
AwsAccountId: str,
DashboardId: str,
) -> DescribeDashboardPermissionsResponseTypeDef: # (1)
...
# describe_dashboard_permissions method usage example with argument unpacking
kwargs: DescribeDashboardPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
}
parent.describe_dashboard_permissions(**kwargs)
describe_dashboard_snapshot_job#
Describes an existing snapshot job.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard_snapshot_job
method.
boto3 documentation
# describe_dashboard_snapshot_job method definition
def describe_dashboard_snapshot_job(
self,
*,
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
) -> DescribeDashboardSnapshotJobResponseTypeDef: # (1)
...
# describe_dashboard_snapshot_job method usage example with argument unpacking
kwargs: DescribeDashboardSnapshotJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"SnapshotJobId": ...,
}
parent.describe_dashboard_snapshot_job(**kwargs)
describe_dashboard_snapshot_job_result#
Describes the result of an existing snapshot job that has finished running.
Type annotations and code completion for boto3.client("quicksight").describe_dashboard_snapshot_job_result
method.
boto3 documentation
# describe_dashboard_snapshot_job_result method definition
def describe_dashboard_snapshot_job_result(
self,
*,
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
) -> DescribeDashboardSnapshotJobResultResponseTypeDef: # (1)
...
# describe_dashboard_snapshot_job_result method usage example with argument unpacking
kwargs: DescribeDashboardSnapshotJobResultRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"SnapshotJobId": ...,
}
parent.describe_dashboard_snapshot_job_result(**kwargs)
describe_data_set#
Describes a dataset.
Type annotations and code completion for boto3.client("quicksight").describe_data_set
method.
boto3 documentation
# describe_data_set method definition
def describe_data_set(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DescribeDataSetResponseTypeDef: # (1)
...
# describe_data_set method usage example with argument unpacking
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
# describe_data_set_permissions method definition
def describe_data_set_permissions(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DescribeDataSetPermissionsResponseTypeDef: # (1)
...
# describe_data_set_permissions method usage example with argument unpacking
kwargs: DescribeDataSetPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.describe_data_set_permissions(**kwargs)
describe_data_set_refresh_properties#
Describes the refresh properties of a dataset.
Type annotations and code completion for boto3.client("quicksight").describe_data_set_refresh_properties
method.
boto3 documentation
# describe_data_set_refresh_properties method definition
def describe_data_set_refresh_properties(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> DescribeDataSetRefreshPropertiesResponseTypeDef: # (1)
...
# describe_data_set_refresh_properties method usage example with argument unpacking
kwargs: DescribeDataSetRefreshPropertiesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.describe_data_set_refresh_properties(**kwargs)
describe_data_source#
Describes a data source.
Type annotations and code completion for boto3.client("quicksight").describe_data_source
method.
boto3 documentation
# describe_data_source method definition
def describe_data_source(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DescribeDataSourceResponseTypeDef: # (1)
...
# describe_data_source method usage example with argument unpacking
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
# describe_data_source_permissions method definition
def describe_data_source_permissions(
self,
*,
AwsAccountId: str,
DataSourceId: str,
) -> DescribeDataSourcePermissionsResponseTypeDef: # (1)
...
# describe_data_source_permissions method usage example with argument unpacking
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
# describe_folder method definition
def describe_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
) -> DescribeFolderResponseTypeDef: # (1)
...
# describe_folder method usage example with argument unpacking
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
# describe_folder_permissions method definition
def describe_folder_permissions(
self,
*,
AwsAccountId: str,
FolderId: str,
Namespace: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeFolderPermissionsResponseTypeDef: # (1)
...
# describe_folder_permissions method usage example with argument unpacking
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
# describe_folder_resolved_permissions method definition
def describe_folder_resolved_permissions(
self,
*,
AwsAccountId: str,
FolderId: str,
Namespace: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeFolderResolvedPermissionsResponseTypeDef: # (1)
...
# describe_folder_resolved_permissions method usage example with argument unpacking
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
# describe_group method definition
def describe_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeGroupResponseTypeDef: # (1)
...
# describe_group method usage example with argument unpacking
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
# describe_group_membership method definition
def describe_group_membership(
self,
*,
MemberName: str,
GroupName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeGroupMembershipResponseTypeDef: # (1)
...
# describe_group_membership method usage example with argument unpacking
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
# describe_iam_policy_assignment method definition
def describe_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
) -> DescribeIAMPolicyAssignmentResponseTypeDef: # (1)
...
# describe_iam_policy_assignment method usage example with argument unpacking
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
# describe_ingestion method definition
def describe_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> DescribeIngestionResponseTypeDef: # (1)
...
# describe_ingestion method usage example with argument unpacking
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
# describe_ip_restriction method definition
def describe_ip_restriction(
self,
*,
AwsAccountId: str,
) -> DescribeIpRestrictionResponseTypeDef: # (1)
...
# describe_ip_restriction method usage example with argument unpacking
kwargs: DescribeIpRestrictionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_ip_restriction(**kwargs)
describe_key_registration#
Describes all customer managed key registrations in a Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").describe_key_registration
method.
boto3 documentation
# describe_key_registration method definition
def describe_key_registration(
self,
*,
AwsAccountId: str,
DefaultKeyOnly: bool = ...,
) -> DescribeKeyRegistrationResponseTypeDef: # (1)
...
# describe_key_registration method usage example with argument unpacking
kwargs: DescribeKeyRegistrationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_key_registration(**kwargs)
describe_namespace#
Describes the current namespace.
Type annotations and code completion for boto3.client("quicksight").describe_namespace
method.
boto3 documentation
# describe_namespace method definition
def describe_namespace(
self,
*,
AwsAccountId: str,
Namespace: str,
) -> DescribeNamespaceResponseTypeDef: # (1)
...
# describe_namespace method usage example with argument unpacking
kwargs: DescribeNamespaceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_namespace(**kwargs)
describe_q_personalization_configuration#
Describes a personalization configuration.
Type annotations and code completion for boto3.client("quicksight").describe_q_personalization_configuration
method.
boto3 documentation
# describe_q_personalization_configuration method definition
def describe_q_personalization_configuration(
self,
*,
AwsAccountId: str,
) -> DescribeQPersonalizationConfigurationResponseTypeDef: # (1)
...
# describe_q_personalization_configuration method usage example with argument unpacking
kwargs: DescribeQPersonalizationConfigurationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.describe_q_personalization_configuration(**kwargs)
describe_refresh_schedule#
Provides a summary of a refresh schedule.
Type annotations and code completion for boto3.client("quicksight").describe_refresh_schedule
method.
boto3 documentation
# describe_refresh_schedule method definition
def describe_refresh_schedule(
self,
*,
AwsAccountId: str,
DataSetId: str,
ScheduleId: str,
) -> DescribeRefreshScheduleResponseTypeDef: # (1)
...
# describe_refresh_schedule method usage example with argument unpacking
kwargs: DescribeRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"ScheduleId": ...,
}
parent.describe_refresh_schedule(**kwargs)
describe_role_custom_permission#
Describes all custom permissions that are mapped to a role.
Type annotations and code completion for boto3.client("quicksight").describe_role_custom_permission
method.
boto3 documentation
# describe_role_custom_permission method definition
def describe_role_custom_permission(
self,
*,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
) -> DescribeRoleCustomPermissionResponseTypeDef: # (2)
...
# describe_role_custom_permission method usage example with argument unpacking
kwargs: DescribeRoleCustomPermissionRequestRequestTypeDef = { # (1)
"Role": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_role_custom_permission(**kwargs)
describe_template#
Describes a template's metadata.
Type annotations and code completion for boto3.client("quicksight").describe_template
method.
boto3 documentation
# describe_template method definition
def describe_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeTemplateResponseTypeDef: # (1)
...
# describe_template method usage example with argument unpacking
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
# describe_template_alias method definition
def describe_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
) -> DescribeTemplateAliasResponseTypeDef: # (1)
...
# describe_template_alias method usage example with argument unpacking
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
# describe_template_definition method definition
def describe_template_definition(
self,
*,
AwsAccountId: str,
TemplateId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeTemplateDefinitionResponseTypeDef: # (1)
...
# describe_template_definition method usage example with argument unpacking
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
# describe_template_permissions method definition
def describe_template_permissions(
self,
*,
AwsAccountId: str,
TemplateId: str,
) -> DescribeTemplatePermissionsResponseTypeDef: # (1)
...
# describe_template_permissions method usage example with argument unpacking
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
# describe_theme method definition
def describe_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
VersionNumber: int = ...,
AliasName: str = ...,
) -> DescribeThemeResponseTypeDef: # (1)
...
# describe_theme method usage example with argument unpacking
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
# describe_theme_alias method definition
def describe_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
) -> DescribeThemeAliasResponseTypeDef: # (1)
...
# describe_theme_alias method usage example with argument unpacking
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
# describe_theme_permissions method definition
def describe_theme_permissions(
self,
*,
AwsAccountId: str,
ThemeId: str,
) -> DescribeThemePermissionsResponseTypeDef: # (1)
...
# describe_theme_permissions method usage example with argument unpacking
kwargs: DescribeThemePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.describe_theme_permissions(**kwargs)
describe_topic#
Describes a topic.
Type annotations and code completion for boto3.client("quicksight").describe_topic
method.
boto3 documentation
# describe_topic method definition
def describe_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> DescribeTopicResponseTypeDef: # (1)
...
# describe_topic method usage example with argument unpacking
kwargs: DescribeTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.describe_topic(**kwargs)
describe_topic_permissions#
Describes the permissions of a topic.
Type annotations and code completion for boto3.client("quicksight").describe_topic_permissions
method.
boto3 documentation
# describe_topic_permissions method definition
def describe_topic_permissions(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> DescribeTopicPermissionsResponseTypeDef: # (1)
...
# describe_topic_permissions method usage example with argument unpacking
kwargs: DescribeTopicPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.describe_topic_permissions(**kwargs)
describe_topic_refresh#
Describes the status of a topic refresh.
Type annotations and code completion for boto3.client("quicksight").describe_topic_refresh
method.
boto3 documentation
# describe_topic_refresh method definition
def describe_topic_refresh(
self,
*,
AwsAccountId: str,
TopicId: str,
RefreshId: str,
) -> DescribeTopicRefreshResponseTypeDef: # (1)
...
# describe_topic_refresh method usage example with argument unpacking
kwargs: DescribeTopicRefreshRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"RefreshId": ...,
}
parent.describe_topic_refresh(**kwargs)
describe_topic_refresh_schedule#
Deletes a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").describe_topic_refresh_schedule
method.
boto3 documentation
# describe_topic_refresh_schedule method definition
def describe_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetId: str,
) -> DescribeTopicRefreshScheduleResponseTypeDef: # (1)
...
# describe_topic_refresh_schedule method usage example with argument unpacking
kwargs: DescribeTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetId": ...,
}
parent.describe_topic_refresh_schedule(**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
# describe_user method definition
def describe_user(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
) -> DescribeUserResponseTypeDef: # (1)
...
# describe_user method usage example with argument unpacking
kwargs: DescribeUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.describe_user(**kwargs)
describe_vpc_connection#
Describes a VPC connection.
Type annotations and code completion for boto3.client("quicksight").describe_vpc_connection
method.
boto3 documentation
# describe_vpc_connection method definition
def describe_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
) -> DescribeVPCConnectionResponseTypeDef: # (1)
...
# describe_vpc_connection method usage example with argument unpacking
kwargs: DescribeVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
}
parent.describe_vpc_connection(**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
# generate_embed_url_for_anonymous_user method definition
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
# generate_embed_url_for_anonymous_user method usage example with argument unpacking
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
# generate_embed_url_for_registered_user method definition
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
# generate_embed_url_for_registered_user method usage example with argument unpacking
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
# generate_presigned_url method definition
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
# get_dashboard_embed_url method definition
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)
...
# get_dashboard_embed_url method usage example with argument unpacking
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
# get_session_embed_url method definition
def get_session_embed_url(
self,
*,
AwsAccountId: str,
EntryPoint: str = ...,
SessionLifetimeInMinutes: int = ...,
UserArn: str = ...,
) -> GetSessionEmbedUrlResponseTypeDef: # (1)
...
# get_session_embed_url method usage example with argument unpacking
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
# list_analyses method definition
def list_analyses(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAnalysesResponseTypeDef: # (1)
...
# list_analyses method usage example with argument unpacking
kwargs: ListAnalysesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_analyses(**kwargs)
list_asset_bundle_export_jobs#
Lists all asset bundle export jobs that have been taken place in the last 14 days.
Type annotations and code completion for boto3.client("quicksight").list_asset_bundle_export_jobs
method.
boto3 documentation
# list_asset_bundle_export_jobs method definition
def list_asset_bundle_export_jobs(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAssetBundleExportJobsResponseTypeDef: # (1)
...
# list_asset_bundle_export_jobs method usage example with argument unpacking
kwargs: ListAssetBundleExportJobsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_asset_bundle_export_jobs(**kwargs)
list_asset_bundle_import_jobs#
Lists all asset bundle import jobs that have taken place in the last 14 days.
Type annotations and code completion for boto3.client("quicksight").list_asset_bundle_import_jobs
method.
boto3 documentation
# list_asset_bundle_import_jobs method definition
def list_asset_bundle_import_jobs(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAssetBundleImportJobsResponseTypeDef: # (1)
...
# list_asset_bundle_import_jobs method usage example with argument unpacking
kwargs: ListAssetBundleImportJobsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_asset_bundle_import_jobs(**kwargs)
list_brands#
Lists all brands in an Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").list_brands
method.
boto3 documentation
# list_brands method definition
def list_brands(
self,
*,
AwsAccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListBrandsResponseTypeDef: # (1)
...
# list_brands method usage example with argument unpacking
kwargs: ListBrandsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_brands(**kwargs)
list_custom_permissions#
Returns a list of all the custom permissions profiles.
Type annotations and code completion for boto3.client("quicksight").list_custom_permissions
method.
boto3 documentation
# list_custom_permissions method definition
def list_custom_permissions(
self,
*,
AwsAccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListCustomPermissionsResponseTypeDef: # (1)
...
# list_custom_permissions method usage example with argument unpacking
kwargs: ListCustomPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_custom_permissions(**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
# list_dashboard_versions method definition
def list_dashboard_versions(
self,
*,
AwsAccountId: str,
DashboardId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDashboardVersionsResponseTypeDef: # (1)
...
# list_dashboard_versions method usage example with argument unpacking
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
# list_dashboards method definition
def list_dashboards(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDashboardsResponseTypeDef: # (1)
...
# list_dashboards method usage example with argument unpacking
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
# list_data_sets method definition
def list_data_sets(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataSetsResponseTypeDef: # (1)
...
# list_data_sets method usage example with argument unpacking
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
# list_data_sources method definition
def list_data_sources(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListDataSourcesResponseTypeDef: # (1)
...
# list_data_sources method usage example with argument unpacking
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
# list_folder_members method definition
def list_folder_members(
self,
*,
AwsAccountId: str,
FolderId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFolderMembersResponseTypeDef: # (1)
...
# list_folder_members method usage example with argument unpacking
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
# list_folders method definition
def list_folders(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFoldersResponseTypeDef: # (1)
...
# list_folders method usage example with argument unpacking
kwargs: ListFoldersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_folders(**kwargs)
list_folders_for_resource#
List all folders that a resource is a member of.
Type annotations and code completion for boto3.client("quicksight").list_folders_for_resource
method.
boto3 documentation
# list_folders_for_resource method definition
def list_folders_for_resource(
self,
*,
AwsAccountId: str,
ResourceArn: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListFoldersForResourceResponseTypeDef: # (1)
...
# list_folders_for_resource method usage example with argument unpacking
kwargs: ListFoldersForResourceRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ResourceArn": ...,
}
parent.list_folders_for_resource(**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
# list_group_memberships method definition
def list_group_memberships(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGroupMembershipsResponseTypeDef: # (1)
...
# list_group_memberships method usage example with argument unpacking
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
# list_groups method definition
def list_groups(
self,
*,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListGroupsResponseTypeDef: # (1)
...
# list_groups method usage example with argument unpacking
kwargs: ListGroupsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_groups(**kwargs)
list_iam_policy_assignments#
Lists the 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
# list_iam_policy_assignments method definition
def list_iam_policy_assignments(
self,
*,
AwsAccountId: str,
Namespace: str,
AssignmentStatus: AssignmentStatusType = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsResponseTypeDef: # (2)
...
# list_iam_policy_assignments method usage example with argument unpacking
kwargs: ListIAMPolicyAssignmentsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_iam_policy_assignments(**kwargs)
list_iam_policy_assignments_for_user#
Lists all of 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
# list_iam_policy_assignments_for_user method definition
def list_iam_policy_assignments_for_user(
self,
*,
AwsAccountId: str,
UserName: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIAMPolicyAssignmentsForUserResponseTypeDef: # (1)
...
# list_iam_policy_assignments_for_user method usage example with argument unpacking
kwargs: ListIAMPolicyAssignmentsForUserRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"UserName": ...,
"Namespace": ...,
}
parent.list_iam_policy_assignments_for_user(**kwargs)
list_identity_propagation_configs#
Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.
Type annotations and code completion for boto3.client("quicksight").list_identity_propagation_configs
method.
boto3 documentation
# list_identity_propagation_configs method definition
def list_identity_propagation_configs(
self,
*,
AwsAccountId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListIdentityPropagationConfigsResponseTypeDef: # (1)
...
# list_identity_propagation_configs method usage example with argument unpacking
kwargs: ListIdentityPropagationConfigsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_identity_propagation_configs(**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
# list_ingestions method definition
def list_ingestions(
self,
*,
DataSetId: str,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListIngestionsResponseTypeDef: # (1)
...
# list_ingestions method usage example with argument unpacking
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
# list_namespaces method definition
def list_namespaces(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListNamespacesResponseTypeDef: # (1)
...
# list_namespaces method usage example with argument unpacking
kwargs: ListNamespacesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_namespaces(**kwargs)
list_refresh_schedules#
Lists the refresh schedules of a dataset.
Type annotations and code completion for boto3.client("quicksight").list_refresh_schedules
method.
boto3 documentation
# list_refresh_schedules method definition
def list_refresh_schedules(
self,
*,
AwsAccountId: str,
DataSetId: str,
) -> ListRefreshSchedulesResponseTypeDef: # (1)
...
# list_refresh_schedules method usage example with argument unpacking
kwargs: ListRefreshSchedulesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
}
parent.list_refresh_schedules(**kwargs)
list_role_memberships#
Lists all groups that are associated with a role.
Type annotations and code completion for boto3.client("quicksight").list_role_memberships
method.
boto3 documentation
# list_role_memberships method definition
def list_role_memberships(
self,
*,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListRoleMembershipsResponseTypeDef: # (2)
...
# list_role_memberships method usage example with argument unpacking
kwargs: ListRoleMembershipsRequestRequestTypeDef = { # (1)
"Role": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_role_memberships(**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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
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
# list_template_aliases method definition
def list_template_aliases(
self,
*,
AwsAccountId: str,
TemplateId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplateAliasesResponseTypeDef: # (1)
...
# list_template_aliases method usage example with argument unpacking
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
# list_template_versions method definition
def list_template_versions(
self,
*,
AwsAccountId: str,
TemplateId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplateVersionsResponseTypeDef: # (1)
...
# list_template_versions method usage example with argument unpacking
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
# list_templates method definition
def list_templates(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTemplatesResponseTypeDef: # (1)
...
# list_templates method usage example with argument unpacking
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
# list_theme_aliases method definition
def list_theme_aliases(
self,
*,
AwsAccountId: str,
ThemeId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListThemeAliasesResponseTypeDef: # (1)
...
# list_theme_aliases method usage example with argument unpacking
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
# list_theme_versions method definition
def list_theme_versions(
self,
*,
AwsAccountId: str,
ThemeId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListThemeVersionsResponseTypeDef: # (1)
...
# list_theme_versions method usage example with argument unpacking
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
# list_themes method definition
def list_themes(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
Type: ThemeTypeType = ..., # (1)
) -> ListThemesResponseTypeDef: # (2)
...
# list_themes method usage example with argument unpacking
kwargs: ListThemesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_themes(**kwargs)
list_topic_refresh_schedules#
Lists all of the refresh schedules for a topic.
Type annotations and code completion for boto3.client("quicksight").list_topic_refresh_schedules
method.
boto3 documentation
# list_topic_refresh_schedules method definition
def list_topic_refresh_schedules(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> ListTopicRefreshSchedulesResponseTypeDef: # (1)
...
# list_topic_refresh_schedules method usage example with argument unpacking
kwargs: ListTopicRefreshSchedulesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.list_topic_refresh_schedules(**kwargs)
list_topic_reviewed_answers#
Lists all reviewed answers for a Q Topic.
Type annotations and code completion for boto3.client("quicksight").list_topic_reviewed_answers
method.
boto3 documentation
# list_topic_reviewed_answers method definition
def list_topic_reviewed_answers(
self,
*,
AwsAccountId: str,
TopicId: str,
) -> ListTopicReviewedAnswersResponseTypeDef: # (1)
...
# list_topic_reviewed_answers method usage example with argument unpacking
kwargs: ListTopicReviewedAnswersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.list_topic_reviewed_answers(**kwargs)
list_topics#
Lists all of the topics within an account.
Type annotations and code completion for boto3.client("quicksight").list_topics
method.
boto3 documentation
# list_topics method definition
def list_topics(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListTopicsResponseTypeDef: # (1)
...
# list_topics method usage example with argument unpacking
kwargs: ListTopicsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_topics(**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
# list_user_groups method definition
def list_user_groups(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUserGroupsResponseTypeDef: # (1)
...
# list_user_groups method usage example with argument unpacking
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
# list_users method definition
def list_users(
self,
*,
AwsAccountId: str,
Namespace: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListUsersResponseTypeDef: # (1)
...
# list_users method usage example with argument unpacking
kwargs: ListUsersRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
}
parent.list_users(**kwargs)
list_vpc_connections#
Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
Type annotations and code completion for boto3.client("quicksight").list_vpc_connections
method.
boto3 documentation
# list_vpc_connections method definition
def list_vpc_connections(
self,
*,
AwsAccountId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListVPCConnectionsResponseTypeDef: # (1)
...
# list_vpc_connections method usage example with argument unpacking
kwargs: ListVPCConnectionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.list_vpc_connections(**kwargs)
put_data_set_refresh_properties#
Creates or updates the dataset refresh properties for the dataset.
Type annotations and code completion for boto3.client("quicksight").put_data_set_refresh_properties
method.
boto3 documentation
# put_data_set_refresh_properties method definition
def put_data_set_refresh_properties(
self,
*,
AwsAccountId: str,
DataSetId: str,
DataSetRefreshProperties: DataSetRefreshPropertiesTypeDef, # (1)
) -> PutDataSetRefreshPropertiesResponseTypeDef: # (2)
...
# put_data_set_refresh_properties method usage example with argument unpacking
kwargs: PutDataSetRefreshPropertiesRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"DataSetRefreshProperties": ...,
}
parent.put_data_set_refresh_properties(**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
# register_user method definition
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 = ...,
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> RegisterUserResponseTypeDef: # (4)
...
- See IdentityTypeType
- See UserRoleType
- See TagTypeDef
- See RegisterUserResponseTypeDef
# register_user method usage example with argument unpacking
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
# restore_analysis method definition
def restore_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
RestoreToFolders: bool = ...,
) -> RestoreAnalysisResponseTypeDef: # (1)
...
# restore_analysis method usage example with argument unpacking
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
# search_analyses method definition
def search_analyses(
self,
*,
AwsAccountId: str,
Filters: Sequence[AnalysisSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchAnalysesResponseTypeDef: # (2)
...
# search_analyses method usage example with argument unpacking
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
# search_dashboards method definition
def search_dashboards(
self,
*,
AwsAccountId: str,
Filters: Sequence[DashboardSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDashboardsResponseTypeDef: # (2)
...
# search_dashboards method usage example with argument unpacking
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
# search_data_sets method definition
def search_data_sets(
self,
*,
AwsAccountId: str,
Filters: Sequence[DataSetSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDataSetsResponseTypeDef: # (2)
...
# search_data_sets method usage example with argument unpacking
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
# search_data_sources method definition
def search_data_sources(
self,
*,
AwsAccountId: str,
Filters: Sequence[DataSourceSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchDataSourcesResponseTypeDef: # (2)
...
# search_data_sources method usage example with argument unpacking
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
# search_folders method definition
def search_folders(
self,
*,
AwsAccountId: str,
Filters: Sequence[FolderSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchFoldersResponseTypeDef: # (2)
...
# search_folders method usage example with argument unpacking
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
# search_groups method definition
def search_groups(
self,
*,
AwsAccountId: str,
Namespace: str,
Filters: Sequence[GroupSearchFilterTypeDef], # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> SearchGroupsResponseTypeDef: # (2)
...
# search_groups method usage example with argument unpacking
kwargs: SearchGroupsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Namespace": ...,
"Filters": ...,
}
parent.search_groups(**kwargs)
start_asset_bundle_export_job#
Starts an Asset Bundle export job.
Type annotations and code completion for boto3.client("quicksight").start_asset_bundle_export_job
method.
boto3 documentation
# start_asset_bundle_export_job method definition
def start_asset_bundle_export_job(
self,
*,
AwsAccountId: str,
AssetBundleExportJobId: str,
ResourceArns: Sequence[str],
ExportFormat: AssetBundleExportFormatType, # (1)
IncludeAllDependencies: bool = ...,
CloudFormationOverridePropertyConfiguration: AssetBundleCloudFormationOverridePropertyConfigurationTypeDef = ..., # (2)
IncludePermissions: bool = ...,
IncludeTags: bool = ...,
ValidationStrategy: AssetBundleExportJobValidationStrategyTypeDef = ..., # (3)
IncludeFolderMemberships: bool = ...,
IncludeFolderMembers: IncludeFolderMembersType = ..., # (4)
) -> StartAssetBundleExportJobResponseTypeDef: # (5)
...
- See AssetBundleExportFormatType
- See AssetBundleCloudFormationOverridePropertyConfigurationTypeDef
- See AssetBundleExportJobValidationStrategyTypeDef
- See IncludeFolderMembersType
- See StartAssetBundleExportJobResponseTypeDef
# start_asset_bundle_export_job method usage example with argument unpacking
kwargs: StartAssetBundleExportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleExportJobId": ...,
"ResourceArns": ...,
"ExportFormat": ...,
}
parent.start_asset_bundle_export_job(**kwargs)
start_asset_bundle_import_job#
Starts an Asset Bundle import job.
Type annotations and code completion for boto3.client("quicksight").start_asset_bundle_import_job
method.
boto3 documentation
# start_asset_bundle_import_job method definition
def start_asset_bundle_import_job(
self,
*,
AwsAccountId: str,
AssetBundleImportJobId: str,
AssetBundleImportSource: AssetBundleImportSourceTypeDef, # (1)
OverrideParameters: AssetBundleImportJobOverrideParametersTypeDef = ..., # (2)
FailureAction: AssetBundleImportFailureActionType = ..., # (3)
OverridePermissions: AssetBundleImportJobOverridePermissionsTypeDef = ..., # (4)
OverrideTags: AssetBundleImportJobOverrideTagsTypeDef = ..., # (5)
OverrideValidationStrategy: AssetBundleImportJobOverrideValidationStrategyTypeDef = ..., # (6)
) -> StartAssetBundleImportJobResponseTypeDef: # (7)
...
- See AssetBundleImportSourceTypeDef
- See AssetBundleImportJobOverrideParametersTypeDef
- See AssetBundleImportFailureActionType
- See AssetBundleImportJobOverridePermissionsTypeDef
- See AssetBundleImportJobOverrideTagsTypeDef
- See AssetBundleImportJobOverrideValidationStrategyTypeDef
- See StartAssetBundleImportJobResponseTypeDef
# start_asset_bundle_import_job method usage example with argument unpacking
kwargs: StartAssetBundleImportJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssetBundleImportJobId": ...,
"AssetBundleImportSource": ...,
}
parent.start_asset_bundle_import_job(**kwargs)
start_dashboard_snapshot_job#
Starts an asynchronous job that generates a snapshot of a dashboard's output.
Type annotations and code completion for boto3.client("quicksight").start_dashboard_snapshot_job
method.
boto3 documentation
# start_dashboard_snapshot_job method definition
def start_dashboard_snapshot_job(
self,
*,
AwsAccountId: str,
DashboardId: str,
SnapshotJobId: str,
UserConfiguration: SnapshotUserConfigurationTypeDef, # (1)
SnapshotConfiguration: SnapshotConfigurationTypeDef, # (2)
) -> StartDashboardSnapshotJobResponseTypeDef: # (3)
...
- See SnapshotUserConfigurationTypeDef
- See SnapshotConfigurationTypeDef
- See StartDashboardSnapshotJobResponseTypeDef
# start_dashboard_snapshot_job method usage example with argument unpacking
kwargs: StartDashboardSnapshotJobRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"SnapshotJobId": ...,
"UserConfiguration": ...,
"SnapshotConfiguration": ...,
}
parent.start_dashboard_snapshot_job(**kwargs)
start_dashboard_snapshot_job_schedule#
Starts an asynchronous job that runs an existing dashboard schedule and sends the dashboard snapshot through email.
Type annotations and code completion for boto3.client("quicksight").start_dashboard_snapshot_job_schedule
method.
boto3 documentation
# start_dashboard_snapshot_job_schedule method definition
def start_dashboard_snapshot_job_schedule(
self,
*,
AwsAccountId: str,
DashboardId: str,
ScheduleId: str,
) -> StartDashboardSnapshotJobScheduleResponseTypeDef: # (1)
...
# start_dashboard_snapshot_job_schedule method usage example with argument unpacking
kwargs: StartDashboardSnapshotJobScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"ScheduleId": ...,
}
parent.start_dashboard_snapshot_job_schedule(**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
# tag_resource method definition
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> TagResourceResponseTypeDef: # (2)
...
- See TagTypeDef
- See TagResourceResponseTypeDef
# tag_resource method usage example with argument unpacking
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
# untag_resource method definition
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> UntagResourceResponseTypeDef: # (1)
...
# untag_resource method usage example with argument unpacking
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
# update_account_customization method definition
def update_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
) -> UpdateAccountCustomizationResponseTypeDef: # (2)
...
# update_account_customization method usage example with argument unpacking
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
# update_account_settings method definition
def update_account_settings(
self,
*,
AwsAccountId: str,
DefaultNamespace: str,
NotificationEmail: str = ...,
TerminationProtectionEnabled: bool = ...,
) -> UpdateAccountSettingsResponseTypeDef: # (1)
...
# update_account_settings method usage example with argument unpacking
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
# update_analysis method definition
def update_analysis(
self,
*,
AwsAccountId: str,
AnalysisId: str,
Name: str,
Parameters: ParametersTypeDef = ..., # (1)
SourceEntity: AnalysisSourceEntityTypeDef = ..., # (2)
ThemeArn: str = ...,
Definition: AnalysisDefinitionTypeDef = ..., # (3)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (4)
) -> UpdateAnalysisResponseTypeDef: # (5)
...
- See ParametersTypeDef
- See AnalysisSourceEntityTypeDef
- See AnalysisDefinitionTypeDef
- See ValidationStrategyTypeDef
- See UpdateAnalysisResponseTypeDef
# update_analysis method usage example with argument unpacking
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
# update_analysis_permissions method definition
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
# update_analysis_permissions method usage example with argument unpacking
kwargs: UpdateAnalysisPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AnalysisId": ...,
}
parent.update_analysis_permissions(**kwargs)
update_brand#
Updates a brand.
Type annotations and code completion for boto3.client("quicksight").update_brand
method.
boto3 documentation
# update_brand method definition
def update_brand(
self,
*,
AwsAccountId: str,
BrandId: str,
BrandDefinition: BrandDefinitionTypeDef = ..., # (1)
) -> UpdateBrandResponseTypeDef: # (2)
...
# update_brand method usage example with argument unpacking
kwargs: UpdateBrandRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
}
parent.update_brand(**kwargs)
update_brand_assignment#
Updates a brand assignment.
Type annotations and code completion for boto3.client("quicksight").update_brand_assignment
method.
boto3 documentation
# update_brand_assignment method definition
def update_brand_assignment(
self,
*,
AwsAccountId: str,
BrandArn: str,
) -> UpdateBrandAssignmentResponseTypeDef: # (1)
...
# update_brand_assignment method usage example with argument unpacking
kwargs: UpdateBrandAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandArn": ...,
}
parent.update_brand_assignment(**kwargs)
update_brand_published_version#
Updates the published version of a brand.
Type annotations and code completion for boto3.client("quicksight").update_brand_published_version
method.
boto3 documentation
# update_brand_published_version method definition
def update_brand_published_version(
self,
*,
AwsAccountId: str,
BrandId: str,
VersionId: str,
) -> UpdateBrandPublishedVersionResponseTypeDef: # (1)
...
# update_brand_published_version method usage example with argument unpacking
kwargs: UpdateBrandPublishedVersionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"BrandId": ...,
"VersionId": ...,
}
parent.update_brand_published_version(**kwargs)
update_custom_permissions#
Updates a custom permissions profile.
Type annotations and code completion for boto3.client("quicksight").update_custom_permissions
method.
boto3 documentation
# update_custom_permissions method definition
def update_custom_permissions(
self,
*,
AwsAccountId: str,
CustomPermissionsName: str,
Capabilities: CapabilitiesTypeDef = ..., # (1)
) -> UpdateCustomPermissionsResponseTypeDef: # (2)
...
# update_custom_permissions method usage example with argument unpacking
kwargs: UpdateCustomPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"CustomPermissionsName": ...,
}
parent.update_custom_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
# update_dashboard method definition
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)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (5)
) -> UpdateDashboardResponseTypeDef: # (6)
...
- See DashboardSourceEntityTypeDef
- See ParametersTypeDef
- See DashboardPublishOptionsTypeDef
- See DashboardVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
- See UpdateDashboardResponseTypeDef
# update_dashboard method usage example with argument unpacking
kwargs: UpdateDashboardRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"Name": ...,
}
parent.update_dashboard(**kwargs)
update_dashboard_links#
Updates the linked analyses on a dashboard.
Type annotations and code completion for boto3.client("quicksight").update_dashboard_links
method.
boto3 documentation
# update_dashboard_links method definition
def update_dashboard_links(
self,
*,
AwsAccountId: str,
DashboardId: str,
LinkEntities: Sequence[str],
) -> UpdateDashboardLinksResponseTypeDef: # (1)
...
# update_dashboard_links method usage example with argument unpacking
kwargs: UpdateDashboardLinksRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DashboardId": ...,
"LinkEntities": ...,
}
parent.update_dashboard_links(**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
# update_dashboard_permissions method definition
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
# update_dashboard_permissions method usage example with argument unpacking
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
# update_dashboard_published_version method definition
def update_dashboard_published_version(
self,
*,
AwsAccountId: str,
DashboardId: str,
VersionNumber: int,
) -> UpdateDashboardPublishedVersionResponseTypeDef: # (1)
...
# update_dashboard_published_version method usage example with argument unpacking
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
# update_data_set method definition
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)
DatasetParameters: Sequence[DatasetParameterTypeDef] = ..., # (10)
) -> UpdateDataSetResponseTypeDef: # (11)
...
- See PhysicalTableTypeDef
- See DataSetImportModeType
- See LogicalTableTypeDef
- See ColumnGroupTypeDef
- See FieldFolderTypeDef
- See RowLevelPermissionDataSetTypeDef
- See RowLevelPermissionTagConfigurationTypeDef
- See ColumnLevelPermissionRuleTypeDef
- See DataSetUsageConfigurationTypeDef
- See DatasetParameterTypeDef
- See UpdateDataSetResponseTypeDef
# update_data_set method usage example with argument unpacking
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
# update_data_set_permissions method definition
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
# update_data_set_permissions method usage example with argument unpacking
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
# update_data_source method definition
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
# update_data_source method usage example with argument unpacking
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
# update_data_source_permissions method definition
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
# update_data_source_permissions method usage example with argument unpacking
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
# update_folder method definition
def update_folder(
self,
*,
AwsAccountId: str,
FolderId: str,
Name: str,
) -> UpdateFolderResponseTypeDef: # (1)
...
# update_folder method usage example with argument unpacking
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
# update_folder_permissions method definition
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
# update_folder_permissions method usage example with argument unpacking
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
# update_group method definition
def update_group(
self,
*,
GroupName: str,
AwsAccountId: str,
Namespace: str,
Description: str = ...,
) -> UpdateGroupResponseTypeDef: # (1)
...
# update_group method usage example with argument unpacking
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
# update_iam_policy_assignment method definition
def update_iam_policy_assignment(
self,
*,
AwsAccountId: str,
AssignmentName: str,
Namespace: str,
AssignmentStatus: AssignmentStatusType = ..., # (1)
PolicyArn: str = ...,
Identities: Mapping[str, Sequence[str]] = ...,
) -> UpdateIAMPolicyAssignmentResponseTypeDef: # (2)
...
# update_iam_policy_assignment method usage example with argument unpacking
kwargs: UpdateIAMPolicyAssignmentRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AssignmentName": ...,
"Namespace": ...,
}
parent.update_iam_policy_assignment(**kwargs)
update_identity_propagation_config#
Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.
Type annotations and code completion for boto3.client("quicksight").update_identity_propagation_config
method.
boto3 documentation
# update_identity_propagation_config method definition
def update_identity_propagation_config(
self,
*,
AwsAccountId: str,
Service: ServiceTypeType, # (1)
AuthorizedTargets: Sequence[str] = ...,
) -> UpdateIdentityPropagationConfigResponseTypeDef: # (2)
...
# update_identity_propagation_config method usage example with argument unpacking
kwargs: UpdateIdentityPropagationConfigRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"Service": ...,
}
parent.update_identity_propagation_config(**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
# update_ip_restriction method definition
def update_ip_restriction(
self,
*,
AwsAccountId: str,
IpRestrictionRuleMap: Mapping[str, str] = ...,
VpcIdRestrictionRuleMap: Mapping[str, str] = ...,
VpcEndpointIdRestrictionRuleMap: Mapping[str, str] = ...,
Enabled: bool = ...,
) -> UpdateIpRestrictionResponseTypeDef: # (1)
...
# update_ip_restriction method usage example with argument unpacking
kwargs: UpdateIpRestrictionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.update_ip_restriction(**kwargs)
update_key_registration#
Updates a customer managed key in a Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").update_key_registration
method.
boto3 documentation
# update_key_registration method definition
def update_key_registration(
self,
*,
AwsAccountId: str,
KeyRegistration: Sequence[RegisteredCustomerManagedKeyTypeDef], # (1)
) -> UpdateKeyRegistrationResponseTypeDef: # (2)
...
# update_key_registration method usage example with argument unpacking
kwargs: UpdateKeyRegistrationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"KeyRegistration": ...,
}
parent.update_key_registration(**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
# update_public_sharing_settings method definition
def update_public_sharing_settings(
self,
*,
AwsAccountId: str,
PublicSharingEnabled: bool = ...,
) -> UpdatePublicSharingSettingsResponseTypeDef: # (1)
...
# update_public_sharing_settings method usage example with argument unpacking
kwargs: UpdatePublicSharingSettingsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
}
parent.update_public_sharing_settings(**kwargs)
update_q_personalization_configuration#
Updates a personalization configuration.
Type annotations and code completion for boto3.client("quicksight").update_q_personalization_configuration
method.
boto3 documentation
# update_q_personalization_configuration method definition
def update_q_personalization_configuration(
self,
*,
AwsAccountId: str,
PersonalizationMode: PersonalizationModeType, # (1)
) -> UpdateQPersonalizationConfigurationResponseTypeDef: # (2)
...
# update_q_personalization_configuration method usage example with argument unpacking
kwargs: UpdateQPersonalizationConfigurationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"PersonalizationMode": ...,
}
parent.update_q_personalization_configuration(**kwargs)
update_refresh_schedule#
Updates a refresh schedule for a dataset.
Type annotations and code completion for boto3.client("quicksight").update_refresh_schedule
method.
boto3 documentation
# update_refresh_schedule method definition
def update_refresh_schedule(
self,
*,
DataSetId: str,
AwsAccountId: str,
Schedule: RefreshScheduleTypeDef, # (1)
) -> UpdateRefreshScheduleResponseTypeDef: # (2)
...
# update_refresh_schedule method usage example with argument unpacking
kwargs: UpdateRefreshScheduleRequestRequestTypeDef = { # (1)
"DataSetId": ...,
"AwsAccountId": ...,
"Schedule": ...,
}
parent.update_refresh_schedule(**kwargs)
update_role_custom_permission#
Updates the custom permissions that are associated with a role.
Type annotations and code completion for boto3.client("quicksight").update_role_custom_permission
method.
boto3 documentation
# update_role_custom_permission method definition
def update_role_custom_permission(
self,
*,
CustomPermissionsName: str,
Role: RoleType, # (1)
AwsAccountId: str,
Namespace: str,
) -> UpdateRoleCustomPermissionResponseTypeDef: # (2)
...
# update_role_custom_permission method usage example with argument unpacking
kwargs: UpdateRoleCustomPermissionRequestRequestTypeDef = { # (1)
"CustomPermissionsName": ...,
"Role": ...,
"AwsAccountId": ...,
"Namespace": ...,
}
parent.update_role_custom_permission(**kwargs)
update_spice_capacity_configuration#
Updates the SPICE capacity configuration for a Amazon QuickSight account.
Type annotations and code completion for boto3.client("quicksight").update_spice_capacity_configuration
method.
boto3 documentation
# update_spice_capacity_configuration method definition
def update_spice_capacity_configuration(
self,
*,
AwsAccountId: str,
PurchaseMode: PurchaseModeType, # (1)
) -> UpdateSPICECapacityConfigurationResponseTypeDef: # (2)
...
# update_spice_capacity_configuration method usage example with argument unpacking
kwargs: UpdateSPICECapacityConfigurationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"PurchaseMode": ...,
}
parent.update_spice_capacity_configuration(**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
# update_template method definition
def update_template(
self,
*,
AwsAccountId: str,
TemplateId: str,
SourceEntity: TemplateSourceEntityTypeDef = ..., # (1)
VersionDescription: str = ...,
Name: str = ...,
Definition: TemplateVersionDefinitionTypeDef = ..., # (2)
ValidationStrategy: ValidationStrategyTypeDef = ..., # (3)
) -> UpdateTemplateResponseTypeDef: # (4)
...
- See TemplateSourceEntityTypeDef
- See TemplateVersionDefinitionTypeDef
- See ValidationStrategyTypeDef
- See UpdateTemplateResponseTypeDef
# update_template method usage example with argument unpacking
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
# update_template_alias method definition
def update_template_alias(
self,
*,
AwsAccountId: str,
TemplateId: str,
AliasName: str,
TemplateVersionNumber: int,
) -> UpdateTemplateAliasResponseTypeDef: # (1)
...
# update_template_alias method usage example with argument unpacking
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
# update_template_permissions method definition
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
# update_template_permissions method usage example with argument unpacking
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
# update_theme method definition
def update_theme(
self,
*,
AwsAccountId: str,
ThemeId: str,
BaseThemeId: str,
Name: str = ...,
VersionDescription: str = ...,
Configuration: ThemeConfigurationTypeDef = ..., # (1)
) -> UpdateThemeResponseTypeDef: # (2)
...
# update_theme method usage example with argument unpacking
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
# update_theme_alias method definition
def update_theme_alias(
self,
*,
AwsAccountId: str,
ThemeId: str,
AliasName: str,
ThemeVersionNumber: int,
) -> UpdateThemeAliasResponseTypeDef: # (1)
...
# update_theme_alias method usage example with argument unpacking
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
# update_theme_permissions method definition
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
# update_theme_permissions method usage example with argument unpacking
kwargs: UpdateThemePermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"ThemeId": ...,
}
parent.update_theme_permissions(**kwargs)
update_topic#
Updates a topic.
Type annotations and code completion for boto3.client("quicksight").update_topic
method.
boto3 documentation
# update_topic method definition
def update_topic(
self,
*,
AwsAccountId: str,
TopicId: str,
Topic: TopicDetailsTypeDef, # (1)
) -> UpdateTopicResponseTypeDef: # (2)
...
# update_topic method usage example with argument unpacking
kwargs: UpdateTopicRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"Topic": ...,
}
parent.update_topic(**kwargs)
update_topic_permissions#
Updates the permissions of a topic.
Type annotations and code completion for boto3.client("quicksight").update_topic_permissions
method.
boto3 documentation
# update_topic_permissions method definition
def update_topic_permissions(
self,
*,
AwsAccountId: str,
TopicId: str,
GrantPermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
RevokePermissions: Sequence[ResourcePermissionTypeDef] = ..., # (1)
) -> UpdateTopicPermissionsResponseTypeDef: # (3)
...
- See ResourcePermissionTypeDef
- See ResourcePermissionTypeDef
- See UpdateTopicPermissionsResponseTypeDef
# update_topic_permissions method usage example with argument unpacking
kwargs: UpdateTopicPermissionsRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
}
parent.update_topic_permissions(**kwargs)
update_topic_refresh_schedule#
Updates a topic refresh schedule.
Type annotations and code completion for boto3.client("quicksight").update_topic_refresh_schedule
method.
boto3 documentation
# update_topic_refresh_schedule method definition
def update_topic_refresh_schedule(
self,
*,
AwsAccountId: str,
TopicId: str,
DatasetId: str,
RefreshSchedule: TopicRefreshScheduleTypeDef, # (1)
) -> UpdateTopicRefreshScheduleResponseTypeDef: # (2)
...
# update_topic_refresh_schedule method usage example with argument unpacking
kwargs: UpdateTopicRefreshScheduleRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"TopicId": ...,
"DatasetId": ...,
"RefreshSchedule": ...,
}
parent.update_topic_refresh_schedule(**kwargs)
update_user#
Updates an Amazon QuickSight user.
Type annotations and code completion for boto3.client("quicksight").update_user
method.
boto3 documentation
# update_user method definition
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)
...
# update_user method usage example with argument unpacking
kwargs: UpdateUserRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
"Email": ...,
"Role": ...,
}
parent.update_user(**kwargs)
update_user_custom_permission#
Updates a custom permissions profile for a user.
Type annotations and code completion for boto3.client("quicksight").update_user_custom_permission
method.
boto3 documentation
# update_user_custom_permission method definition
def update_user_custom_permission(
self,
*,
UserName: str,
AwsAccountId: str,
Namespace: str,
CustomPermissionsName: str,
) -> UpdateUserCustomPermissionResponseTypeDef: # (1)
...
# update_user_custom_permission method usage example with argument unpacking
kwargs: UpdateUserCustomPermissionRequestRequestTypeDef = { # (1)
"UserName": ...,
"AwsAccountId": ...,
"Namespace": ...,
"CustomPermissionsName": ...,
}
parent.update_user_custom_permission(**kwargs)
update_vpc_connection#
Updates a VPC connection.
Type annotations and code completion for boto3.client("quicksight").update_vpc_connection
method.
boto3 documentation
# update_vpc_connection method definition
def update_vpc_connection(
self,
*,
AwsAccountId: str,
VPCConnectionId: str,
Name: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
RoleArn: str,
DnsResolvers: Sequence[str] = ...,
) -> UpdateVPCConnectionResponseTypeDef: # (1)
...
# update_vpc_connection method usage example with argument unpacking
kwargs: UpdateVPCConnectionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"VPCConnectionId": ...,
"Name": ...,
"SubnetIds": ...,
"SecurityGroupIds": ...,
"RoleArn": ...,
}
parent.update_vpc_connection(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("quicksight").get_paginator
method with overloads.
client.get_paginator("describe_folder_permissions")
-> DescribeFolderPermissionsPaginatorclient.get_paginator("describe_folder_resolved_permissions")
-> DescribeFolderResolvedPermissionsPaginatorclient.get_paginator("list_analyses")
-> ListAnalysesPaginatorclient.get_paginator("list_asset_bundle_export_jobs")
-> ListAssetBundleExportJobsPaginatorclient.get_paginator("list_asset_bundle_import_jobs")
-> ListAssetBundleImportJobsPaginatorclient.get_paginator("list_brands")
-> ListBrandsPaginatorclient.get_paginator("list_custom_permissions")
-> ListCustomPermissionsPaginatorclient.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_folder_members")
-> ListFolderMembersPaginatorclient.get_paginator("list_folders_for_resource")
-> ListFoldersForResourcePaginatorclient.get_paginator("list_folders")
-> ListFoldersPaginatorclient.get_paginator("list_group_memberships")
-> ListGroupMembershipsPaginatorclient.get_paginator("list_groups")
-> ListGroupsPaginatorclient.get_paginator("list_iam_policy_assignments_for_user")
-> ListIAMPolicyAssignmentsForUserPaginatorclient.get_paginator("list_iam_policy_assignments")
-> ListIAMPolicyAssignmentsPaginatorclient.get_paginator("list_ingestions")
-> ListIngestionsPaginatorclient.get_paginator("list_namespaces")
-> ListNamespacesPaginatorclient.get_paginator("list_role_memberships")
-> ListRoleMembershipsPaginatorclient.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("list_user_groups")
-> ListUserGroupsPaginatorclient.get_paginator("list_users")
-> ListUsersPaginatorclient.get_paginator("search_analyses")
-> SearchAnalysesPaginatorclient.get_paginator("search_dashboards")
-> SearchDashboardsPaginatorclient.get_paginator("search_data_sets")
-> SearchDataSetsPaginatorclient.get_paginator("search_data_sources")
-> SearchDataSourcesPaginatorclient.get_paginator("search_folders")
-> SearchFoldersPaginatorclient.get_paginator("search_groups")
-> SearchGroupsPaginator