QuickSightClient#
Index > QuickSight > QuickSightClient
Auto-generated documentation for QuickSight type annotations stubs module mypy-boto3-quicksight.
QuickSightClient#
Type annotations and code completion for boto3.client("quicksight")
.
boto3 documentation
# QuickSightClient usage example
from boto3.session import Session
from mypy_boto3_quicksight.client import QuickSightClient
def get_quicksight_client() -> QuickSightClient:
return Session().client("quicksight")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("quicksight").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("quicksight")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConcurrentUpdatingException,
client.exceptions.ConflictException,
client.exceptions.DomainNotWhitelistedException,
client.exceptions.IdentityTypeNotSupportedException,
client.exceptions.InternalFailureException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.PreconditionNotMetException,
client.exceptions.QuickSightUserNotFoundException,
client.exceptions.ResourceExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ResourceUnavailableException,
client.exceptions.SessionLifetimeInMinutesInvalidException,
client.exceptions.ThrottlingException,
client.exceptions.UnsupportedPricingPlanException,
client.exceptions.UnsupportedUserEditionException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_quicksight.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("quicksight").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_ingestion#
Cancels an ongoing ingestion of data into SPICE.
Type annotations and code completion for boto3.client("quicksight").cancel_ingestion
method.
boto3 documentation
# cancel_ingestion method definition
def cancel_ingestion(
self,
*,
AwsAccountId: str,
DataSetId: str,
IngestionId: str,
) -> CancelIngestionResponseTypeDef: # (1)
...
# cancel_ingestion method usage example with argument unpacking
kwargs: CancelIngestionRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"DataSetId": ...,
"IngestionId": ...,
}
parent.cancel_ingestion(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("quicksight").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_account_customization#
Creates Amazon QuickSight customizations for the current Amazon Web Services Region.
Type annotations and code completion for boto3.client("quicksight").create_account_customization
method.
boto3 documentation
# create_account_customization method definition
def create_account_customization(
self,
*,
AwsAccountId: str,
AccountCustomization: AccountCustomizationTypeDef, # (1)
Namespace: str = ...,
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> CreateAccountCustomizationResponseTypeDef: # (3)
...
# create_account_customization method usage example with argument unpacking
kwargs: CreateAccountCustomizationRequestRequestTypeDef = { # (1)
"AwsAccountId": ...,
"AccountCustomization": ...,
}
parent.create_account_customization(**kwargs)
create_account_subscription#
Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.
Type annotations and code completion for boto3.client("quicksight").create_account_subscription
method.
boto3 documentation
# create_account_subscription method definition
def create_account_subscription(
self,
*,
Edition: EditionType, # (1)
AuthenticationMethod: AuthenticationMethodOptionType, # (2)
AwsAccountId: str,
AccountName: str,
NotificationEmail: str,
ActiveDirectoryName: str = ...,
Realm: str = ...,
DirectoryId: str = ...,
AdminGroup: Sequence[str] = ...,
AuthorGroup: Sequence[str] = ...,
ReaderGroup: Sequence[str] = ...,
FirstName: str = ...,
LastName: str = ...,
EmailAddress: str = ...,
ContactNumber: str = ...,
) -> CreateAccountSubscriptionResponseTypeDef: # (3)
...