Skip to content

finspaceClient

Index > finspace > 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

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.

Usage example
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)
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

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

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

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)
    ...
  1. See FederationModeType
  2. See FederationParametersTypeDef
  3. See SuperuserParametersTypeDef
  4. See CreateEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: CreateEnvironmentRequestRequestTypeDef = {  # (1)
    "name": ...,
}

parent.create_environment(**kwargs)
  1. See CreateEnvironmentRequestRequestTypeDef

delete_environment

Delete an FinSpace environment.

Type annotations and code completion for boto3.client("finspace").delete_environment method. boto3 documentation

Method definition
def delete_environment(
    self,
    *,
    environmentId: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DeleteEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.delete_environment(**kwargs)
  1. See DeleteEnvironmentRequestRequestTypeDef

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

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

Method definition
def get_environment(
    self,
    *,
    environmentId: str,
) -> GetEnvironmentResponseTypeDef:  # (1)
    ...
  1. See GetEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: GetEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.get_environment(**kwargs)
  1. See GetEnvironmentRequestRequestTypeDef

list_environments

A list of all of your FinSpace environments.

Type annotations and code completion for boto3.client("finspace").list_environments method. boto3 documentation

Method definition
def list_environments(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListEnvironmentsResponseTypeDef:  # (1)
    ...
  1. See ListEnvironmentsResponseTypeDef
Usage example with kwargs
kwargs: ListEnvironmentsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_environments(**kwargs)
  1. See ListEnvironmentsRequestRequestTypeDef

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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Adds metadata tags to a FinSpace resource.

Type annotations and code completion for boto3.client("finspace").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes metadata tags from a FinSpace resource.

Type annotations and code completion for boto3.client("finspace").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_environment

Update your FinSpace environment.

Type annotations and code completion for boto3.client("finspace").update_environment method. boto3 documentation

Method definition
def update_environment(
    self,
    *,
    environmentId: str,
    name: str = ...,
    description: str = ...,
    federationMode: FederationModeType = ...,  # (1)
    federationParameters: FederationParametersTypeDef = ...,  # (2)
) -> UpdateEnvironmentResponseTypeDef:  # (3)
    ...
  1. See FederationModeType
  2. See FederationParametersTypeDef
  3. See UpdateEnvironmentResponseTypeDef
Usage example with kwargs
kwargs: UpdateEnvironmentRequestRequestTypeDef = {  # (1)
    "environmentId": ...,
}

parent.update_environment(**kwargs)
  1. See UpdateEnvironmentRequestRequestTypeDef