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
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.
client = boto3.client("finspace")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.InternalServerException,
client.InvalidRequestException,
client.LimitExceededException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("finspace").close
method.
boto3 documentation
create_environment
Create a new FinSpace environment.
Type annotations and code completion for boto3.client("finspace").create_environment
method.
boto3 documentation
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
kwargs: CreateEnvironmentRequestRequestTypeDef = { # (1)
"name": ...,
}
parent.create_environment(**kwargs)
delete_environment
Delete an FinSpace environment.
Type annotations and code completion for boto3.client("finspace").delete_environment
method.
boto3 documentation
kwargs: DeleteEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.delete_environment(**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
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
def get_environment(
self,
*,
environmentId: str,
) -> GetEnvironmentResponseTypeDef: # (1)
...
kwargs: GetEnvironmentRequestRequestTypeDef = { # (1)
"environmentId": ...,
}
parent.get_environment(**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
def list_environments(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListEnvironmentsResponseTypeDef: # (1)
...
kwargs: ListEnvironmentsRequestRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_environments(**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
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
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
def tag_resource(
self,
*,
resourceArn: str,
tags: Mapping[str, str],
) -> Dict[str, Any]:
...
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
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...
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
def update_environment(
self,
*,
environmentId: str,
name: str = ...,
description: str = ...,
federationMode: FederationModeType = ..., # (1)
federationParameters: FederationParametersTypeDef = ..., # (2)
) -> UpdateEnvironmentResponseTypeDef: # (3)
...