finspaceClient#
Auto-generated documentation for finspace type annotations stubs module mypy-boto3-finspace.
finspaceClient#
Type annotations and code completion for boto3.client("finspace")
.
boto3 documentation
# finspaceClient usage example
from boto3.session import Session
from mypy_boto3_finspace.client import finspaceClient
def get_finspace_client() -> finspaceClient:
return Session().client("finspace")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("finspace").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("finspace")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServerException,
client.exceptions.InvalidRequestException,
client.exceptions.LimitExceededException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.ThrottlingException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_finspace.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("finspace").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("finspace").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_environment#
Create a new FinSpace environment.
Type annotations and code completion for boto3.client("finspace").create_environment
method.
boto3 documentation
# create_environment method definition
def create_environment(
self,
*,
name: str,
description: str = ...,
kmsKeyId: str = ...,
tags: Mapping[str, str] = ...,
federationMode: FederationModeType = ..., # (1)
federationParameters: FederationParametersTypeDef = ..., # (2)
superuserParameters: SuperuserParametersTypeDef = ..., # (3)
dataBundles: Sequence[str] = ...,
) -> CreateEnvironmentResponseTypeDef: # (4)
...
- See FederationModeType
- See FederationParametersTypeDef
- See SuperuserParametersTypeDef
- See CreateEnvironmentResponseTypeDef
# create_environment method usage example with argument unpacking
kwargs: CreateEnvironmentRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_environment(**kwargs)
create_kx_changeset#
Creates a changeset for a kdb database.
Type annotations and code completion for boto3.client("finspace").create_kx_changeset
method.
boto3 documentation
# create_kx_changeset method definition
def create_kx_changeset(
self,
*,
environmentId: str,
databaseName: str,
changeRequests: Sequence[ChangeRequestTypeDef], # (1)
clientToken: str,
) -> CreateKxChangesetResponseTypeDef: # (2)
...
# create_kx_changeset method usage example with argument unpacking
kwargs: CreateKxChangesetRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
"changeRequests": ...,
"clientToken": ...,
}
parent.create_kx_changeset(**kwargs)
create_kx_cluster#
Creates a new kdb cluster.
Type annotations and code completion for boto3.client("finspace").create_kx_cluster
method.
boto3 documentation
# create_kx_cluster method definition
def create_kx_cluster(
self,
*,
environmentId: str,
clusterName: str,
clusterType: KxClusterTypeType, # (1)
capacityConfiguration: CapacityConfigurationTypeDef, # (2)
releaseLabel: str,
azMode: KxAzModeType, # (3)
clientToken: str = ...,
databases: Sequence[KxDatabaseConfigurationTypeDef] = ..., # (4)
cacheStorageConfigurations: Sequence[KxCacheStorageConfigurationTypeDef] = ..., # (5)
autoScalingConfiguration: AutoScalingConfigurationTypeDef = ..., # (6)
clusterDescription: str = ...,
vpcConfiguration: VpcConfigurationTypeDef = ..., # (7)
initializationScript: str = ...,
commandLineArguments: Sequence[KxCommandLineArgumentTypeDef] = ..., # (8)
code: CodeConfigurationTypeDef = ..., # (9)
executionRole: str = ...,
savedownStorageConfiguration: KxSavedownStorageConfigurationTypeDef = ..., # (10)
availabilityZoneId: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateKxClusterResponseTypeDef: # (11)
...
- See KxClusterTypeType
- See CapacityConfigurationTypeDef
- See KxAzModeType
- See KxDatabaseConfigurationTypeDef
- See KxCacheStorageConfigurationTypeDef
- See AutoScalingConfigurationTypeDef
- See VpcConfigurationTypeDef
- See KxCommandLineArgumentTypeDef
- See CodeConfigurationTypeDef
- See KxSavedownStorageConfigurationTypeDef
- See CreateKxClusterResponseTypeDef
# create_kx_cluster method usage example with argument unpacking
kwargs: CreateKxClusterRequestRequestTypeDef = { # (1)
"environmentId": ...,
"clusterName": ...,
"clusterType": ...,
"capacityConfiguration": ...,
"releaseLabel": ...,
"azMode": ...,
}
parent.create_kx_cluster(**kwargs)
create_kx_database#
Creates a new kdb database in the environment.
Type annotations and code completion for boto3.client("finspace").create_kx_database
method.
boto3 documentation
# create_kx_database method definition
def create_kx_database(
self,
*,
environmentId: str,
databaseName: str,
clientToken: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateKxDatabaseResponseTypeDef: # (1)
...
# create_kx_database method usage example with argument unpacking
kwargs: CreateKxDatabaseRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
"clientToken": ...,
}
parent.create_kx_database(**kwargs)
create_kx_environment#
Creates a managed kdb environment for the account.
Type annotations and code completion for boto3.client("finspace").create_kx_environment
method.
boto3 documentation
# create_kx_environment method definition
def create_kx_environment(
self,
*,
name: str,
kmsKeyId: str,
description: str = ...,
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreateKxEnvironmentResponseTypeDef: # (1)
...
# create_kx_environment method usage example with argument unpacking
kwargs: CreateKxEnvironmentRequestRequestTypeDef = { # (1)
"name": ...,
"kmsKeyId": ...,
}
parent.create_kx_environment(**kwargs)
create_kx_user#
Creates a user in FinSpace kdb environment with an associated IAM role.
Type annotations and code completion for boto3.client("finspace").create_kx_user
method.
boto3 documentation
# create_kx_user method definition
def create_kx_user(
self,
*,
environmentId: str,
userName: str,
iamRole: str,
tags: Mapping[str, str] = ...,
clientToken: str = ...,
) -> CreateKxUserResponseTypeDef: # (1)
...
# create_kx_user method usage example with argument unpacking
kwargs: CreateKxUserRequestRequestTypeDef = { # (1)
"environmentId": ...,
"userName": ...,
"iamRole": ...,
}
parent.create_kx_user(**kwargs)
delete_environment#
Delete an FinSpace environment.
Type annotations and code completion for boto3.client("finspace").delete_environment
method.
boto3 documentation
# delete_environment method definition
def delete_environment(
self,
*,
environmentId: str,
) -> Dict[str, Any]:
...
# delete_environment method usage example with argument unpacking
kwargs: DeleteEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_environment(**kwargs)
delete_kx_cluster#
Deletes a kdb cluster.
Type annotations and code completion for boto3.client("finspace").delete_kx_cluster
method.
boto3 documentation
# delete_kx_cluster method definition
def delete_kx_cluster(
self,
*,
environmentId: str,
clusterName: str,
clientToken: str = ...,
) -> Dict[str, Any]:
...
# delete_kx_cluster method usage example with argument unpacking
kwargs: DeleteKxClusterRequestRequestTypeDef = { # (1)
"environmentId": ...,
"clusterName": ...,
}
parent.delete_kx_cluster(**kwargs)
delete_kx_database#
Deletes the specified database and all of its associated data.
Type annotations and code completion for boto3.client("finspace").delete_kx_database
method.
boto3 documentation
# delete_kx_database method definition
def delete_kx_database(
self,
*,
environmentId: str,
databaseName: str,
clientToken: str,
) -> Dict[str, Any]:
...
# delete_kx_database method usage example with argument unpacking
kwargs: DeleteKxDatabaseRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
"clientToken": ...,
}
parent.delete_kx_database(**kwargs)
delete_kx_environment#
Deletes the kdb environment.
Type annotations and code completion for boto3.client("finspace").delete_kx_environment
method.
boto3 documentation
# delete_kx_environment method definition
def delete_kx_environment(
self,
*,
environmentId: str,
) -> Dict[str, Any]:
...
# delete_kx_environment method usage example with argument unpacking
kwargs: DeleteKxEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_kx_environment(**kwargs)
delete_kx_user#
Deletes a user in the specified kdb environment.
Type annotations and code completion for boto3.client("finspace").delete_kx_user
method.
boto3 documentation
# delete_kx_user method definition
def delete_kx_user(
self,
*,
userName: str,
environmentId: str,
) -> Dict[str, Any]:
...
# delete_kx_user method usage example with argument unpacking
kwargs: DeleteKxUserRequestRequestTypeDef = { # (1)
"userName": ...,
"environmentId": ...,
}
parent.delete_kx_user(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("finspace").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_environment#
Returns the FinSpace environment object.
Type annotations and code completion for boto3.client("finspace").get_environment
method.
boto3 documentation
# get_environment method definition
def get_environment(
self,
*,
environmentId: str,
) -> GetEnvironmentResponseTypeDef: # (1)
...
# get_environment method usage example with argument unpacking
kwargs: GetEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.get_environment(**kwargs)
get_kx_changeset#
Returns information about a kdb changeset.
Type annotations and code completion for boto3.client("finspace").get_kx_changeset
method.
boto3 documentation
# get_kx_changeset method definition
def get_kx_changeset(
self,
*,
environmentId: str,
databaseName: str,
changesetId: str,
) -> GetKxChangesetResponseTypeDef: # (1)
...
# get_kx_changeset method usage example with argument unpacking
kwargs: GetKxChangesetRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
"changesetId": ...,
}
parent.get_kx_changeset(**kwargs)
get_kx_cluster#
Retrieves information about a kdb cluster.
Type annotations and code completion for boto3.client("finspace").get_kx_cluster
method.
boto3 documentation
# get_kx_cluster method definition
def get_kx_cluster(
self,
*,
environmentId: str,
clusterName: str,
) -> GetKxClusterResponseTypeDef: # (1)
...
# get_kx_cluster method usage example with argument unpacking
kwargs: GetKxClusterRequestRequestTypeDef = { # (1)
"environmentId": ...,
"clusterName": ...,
}
parent.get_kx_cluster(**kwargs)
get_kx_connection_string#
Retrieves a connection string for a user to connect to a kdb cluster.
Type annotations and code completion for boto3.client("finspace").get_kx_connection_string
method.
boto3 documentation
# get_kx_connection_string method definition
def get_kx_connection_string(
self,
*,
userArn: str,
environmentId: str,
clusterName: str,
) -> GetKxConnectionStringResponseTypeDef: # (1)
...
# get_kx_connection_string method usage example with argument unpacking
kwargs: GetKxConnectionStringRequestRequestTypeDef = { # (1)
"userArn": ...,
"environmentId": ...,
"clusterName": ...,
}
parent.get_kx_connection_string(**kwargs)
get_kx_database#
Returns database information for the specified environment ID.
Type annotations and code completion for boto3.client("finspace").get_kx_database
method.
boto3 documentation
# get_kx_database method definition
def get_kx_database(
self,
*,
environmentId: str,
databaseName: str,
) -> GetKxDatabaseResponseTypeDef: # (1)
...
# get_kx_database method usage example with argument unpacking
kwargs: GetKxDatabaseRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
}
parent.get_kx_database(**kwargs)
get_kx_environment#
Retrieves all the information for the specified kdb environment.
Type annotations and code completion for boto3.client("finspace").get_kx_environment
method.
boto3 documentation
# get_kx_environment method definition
def get_kx_environment(
self,
*,
environmentId: str,
) -> GetKxEnvironmentResponseTypeDef: # (1)
...
# get_kx_environment method usage example with argument unpacking
kwargs: GetKxEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.get_kx_environment(**kwargs)
get_kx_user#
Retrieves information about the specified kdb user.
Type annotations and code completion for boto3.client("finspace").get_kx_user
method.
boto3 documentation
# get_kx_user method definition
def get_kx_user(
self,
*,
userName: str,
environmentId: str,
) -> GetKxUserResponseTypeDef: # (1)
...
# get_kx_user method usage example with argument unpacking
kwargs: GetKxUserRequestRequestTypeDef = { # (1)
"userName": ...,
"environmentId": ...,
}
parent.get_kx_user(**kwargs)
list_environments#
A list of all of your FinSpace environments.
Type annotations and code completion for boto3.client("finspace").list_environments
method.
boto3 documentation
# list_environments method definition
def list_environments(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEnvironmentsResponseTypeDef: # (1)
...
# list_environments method usage example with argument unpacking
kwargs: ListEnvironmentsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_environments(**kwargs)
list_kx_changesets#
Returns a list of all the changesets for a database.
Type annotations and code completion for boto3.client("finspace").list_kx_changesets
method.
boto3 documentation
# list_kx_changesets method definition
def list_kx_changesets(
self,
*,
environmentId: str,
databaseName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListKxChangesetsResponseTypeDef: # (1)
...
# list_kx_changesets method usage example with argument unpacking
kwargs: ListKxChangesetsRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
}
parent.list_kx_changesets(**kwargs)
list_kx_cluster_nodes#
Lists all the nodes in a kdb cluster.
Type annotations and code completion for boto3.client("finspace").list_kx_cluster_nodes
method.
boto3 documentation
# list_kx_cluster_nodes method definition
def list_kx_cluster_nodes(
self,
*,
environmentId: str,
clusterName: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListKxClusterNodesResponseTypeDef: # (1)
...
# list_kx_cluster_nodes method usage example with argument unpacking
kwargs: ListKxClusterNodesRequestRequestTypeDef = { # (1)
"environmentId": ...,
"clusterName": ...,
}
parent.list_kx_cluster_nodes(**kwargs)
list_kx_clusters#
Returns a list of clusters.
Type annotations and code completion for boto3.client("finspace").list_kx_clusters
method.
boto3 documentation
# list_kx_clusters method definition
def list_kx_clusters(
self,
*,
environmentId: str,
clusterType: KxClusterTypeType = ..., # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListKxClustersResponseTypeDef: # (2)
...
# list_kx_clusters method usage example with argument unpacking
kwargs: ListKxClustersRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_kx_clusters(**kwargs)
list_kx_databases#
Returns a list of all the databases in the kdb environment.
Type annotations and code completion for boto3.client("finspace").list_kx_databases
method.
boto3 documentation
# list_kx_databases method definition
def list_kx_databases(
self,
*,
environmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListKxDatabasesResponseTypeDef: # (1)
...
# list_kx_databases method usage example with argument unpacking
kwargs: ListKxDatabasesRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_kx_databases(**kwargs)
list_kx_environments#
Returns a list of kdb environments created in an account.
Type annotations and code completion for boto3.client("finspace").list_kx_environments
method.
boto3 documentation
# list_kx_environments method definition
def list_kx_environments(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListKxEnvironmentsResponseTypeDef: # (1)
...
# list_kx_environments method usage example with argument unpacking
kwargs: ListKxEnvironmentsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_kx_environments(**kwargs)
list_kx_users#
Lists all the users in a kdb environment.
Type annotations and code completion for boto3.client("finspace").list_kx_users
method.
boto3 documentation
# list_kx_users method definition
def list_kx_users(
self,
*,
environmentId: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListKxUsersResponseTypeDef: # (1)
...
# list_kx_users method usage example with argument unpacking
kwargs: ListKxUsersRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.list_kx_users(**kwargs)
list_tags_for_resource#
A list of all tags for a resource.
Type annotations and code completion for boto3.client("finspace").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)
tag_resource#
Adds metadata tags to a FinSpace resource.
Type annotations and code completion for boto3.client("finspace").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes metadata tags from a FinSpace resource.
Type annotations and code completion for boto3.client("finspace").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)
update_environment#
Update your FinSpace environment.
Type annotations and code completion for boto3.client("finspace").update_environment
method.
boto3 documentation
# update_environment method definition
def update_environment(
self,
*,
environmentId: str,
name: str = ...,
description: str = ...,
federationMode: FederationModeType = ..., # (1)
federationParameters: FederationParametersTypeDef = ..., # (2)
) -> UpdateEnvironmentResponseTypeDef: # (3)
...
# update_environment method usage example with argument unpacking
kwargs: UpdateEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.update_environment(**kwargs)
update_kx_cluster_databases#
Updates the databases mounted on a kdb cluster, which includes the changesetId
and all the dbPaths to be cached.
Type annotations and code completion for boto3.client("finspace").update_kx_cluster_databases
method.
boto3 documentation
# update_kx_cluster_databases method definition
def update_kx_cluster_databases(
self,
*,
environmentId: str,
clusterName: str,
databases: Sequence[KxDatabaseConfigurationTypeDef], # (1)
clientToken: str = ...,
) -> Dict[str, Any]:
...
# update_kx_cluster_databases method usage example with argument unpacking
kwargs: UpdateKxClusterDatabasesRequestRequestTypeDef = { # (1)
"environmentId": ...,
"clusterName": ...,
"databases": ...,
}
parent.update_kx_cluster_databases(**kwargs)
update_kx_database#
Updates information for the given kdb database.
Type annotations and code completion for boto3.client("finspace").update_kx_database
method.
boto3 documentation
# update_kx_database method definition
def update_kx_database(
self,
*,
environmentId: str,
databaseName: str,
clientToken: str,
description: str = ...,
) -> UpdateKxDatabaseResponseTypeDef: # (1)
...
# update_kx_database method usage example with argument unpacking
kwargs: UpdateKxDatabaseRequestRequestTypeDef = { # (1)
"environmentId": ...,
"databaseName": ...,
"clientToken": ...,
}
parent.update_kx_database(**kwargs)
update_kx_environment#
Updates information for the given kdb environment.
Type annotations and code completion for boto3.client("finspace").update_kx_environment
method.
boto3 documentation
# update_kx_environment method definition
def update_kx_environment(
self,
*,
environmentId: str,
name: str = ...,
description: str = ...,
clientToken: str = ...,
) -> UpdateKxEnvironmentResponseTypeDef: # (1)
...
# update_kx_environment method usage example with argument unpacking
kwargs: UpdateKxEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.update_kx_environment(**kwargs)
update_kx_environment_network#
Updates environment network to connect to your internal network by using a transit gateway.
Type annotations and code completion for boto3.client("finspace").update_kx_environment_network
method.
boto3 documentation
# update_kx_environment_network method definition
def update_kx_environment_network(
self,
*,
environmentId: str,
transitGatewayConfiguration: TransitGatewayConfigurationTypeDef = ..., # (1)
customDNSConfiguration: Sequence[CustomDNSServerTypeDef] = ..., # (2)
clientToken: str = ...,
) -> UpdateKxEnvironmentNetworkResponseTypeDef: # (3)
...
- See TransitGatewayConfigurationTypeDef
- See CustomDNSServerTypeDef
- See UpdateKxEnvironmentNetworkResponseTypeDef
# update_kx_environment_network method usage example with argument unpacking
kwargs: UpdateKxEnvironmentNetworkRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.update_kx_environment_network(**kwargs)
update_kx_user#
Updates the user details.
Type annotations and code completion for boto3.client("finspace").update_kx_user
method.
boto3 documentation
# update_kx_user method definition
def update_kx_user(
self,
*,
environmentId: str,
userName: str,
iamRole: str,
clientToken: str = ...,
) -> UpdateKxUserResponseTypeDef: # (1)
...
# update_kx_user method usage example with argument unpacking
kwargs: UpdateKxUserRequestRequestTypeDef = { # (1)
"environmentId": ...,
"userName": ...,
"iamRole": ...,
}
parent.update_kx_user(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("finspace").get_paginator
method with overloads.
client.get_paginator("list_kx_environments")
-> ListKxEnvironmentsPaginator