Typed dictionaries
Auto-generated documentation for finspace type annotations stubs module mypy-boto3-finspace.
FederationParametersTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import FederationParametersTypeDef
def get_value() -> FederationParametersTypeDef:
return {
"samlMetadataDocument": ...,
}
Definition
class FederationParametersTypeDef(TypedDict):
samlMetadataDocument: NotRequired[str],
samlMetadataURL: NotRequired[str],
applicationCallBackURL: NotRequired[str],
federationURN: NotRequired[str],
federationProviderName: NotRequired[str],
attributeMap: NotRequired[Mapping[str, str]],
SuperuserParametersTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import SuperuserParametersTypeDef
def get_value() -> SuperuserParametersTypeDef:
return {
"emailAddress": ...,
"firstName": ...,
"lastName": ...,
}
Definition
class SuperuserParametersTypeDef(TypedDict):
emailAddress: str,
firstName: str,
lastName: str,
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DeleteEnvironmentRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import DeleteEnvironmentRequestRequestTypeDef
def get_value() -> DeleteEnvironmentRequestRequestTypeDef:
return {
"environmentId": ...,
}
GetEnvironmentRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import GetEnvironmentRequestRequestTypeDef
def get_value() -> GetEnvironmentRequestRequestTypeDef:
return {
"environmentId": ...,
}
ListEnvironmentsRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import ListEnvironmentsRequestRequestTypeDef
def get_value() -> ListEnvironmentsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListEnvironmentsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
EnvironmentTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import EnvironmentTypeDef
def get_value() -> EnvironmentTypeDef:
return {
"name": ...,
}
Definition
class EnvironmentTypeDef(TypedDict):
name: NotRequired[str],
environmentId: NotRequired[str],
awsAccountId: NotRequired[str],
status: NotRequired[EnvironmentStatusType], # (1)
environmentUrl: NotRequired[str],
description: NotRequired[str],
environmentArn: NotRequired[str],
sageMakerStudioDomainUrl: NotRequired[str],
kmsKeyId: NotRequired[str],
dedicatedServiceAccountId: NotRequired[str],
federationMode: NotRequired[FederationModeType], # (2)
federationParameters: NotRequired[FederationParametersTypeDef], # (3)
UpdateEnvironmentRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import UpdateEnvironmentRequestRequestTypeDef
def get_value() -> UpdateEnvironmentRequestRequestTypeDef:
return {
"environmentId": ...,
}
Definition
class UpdateEnvironmentRequestRequestTypeDef(TypedDict):
environmentId: str,
name: NotRequired[str],
description: NotRequired[str],
federationMode: NotRequired[FederationModeType], # (1)
federationParameters: NotRequired[FederationParametersTypeDef], # (2)
CreateEnvironmentRequestRequestTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import CreateEnvironmentRequestRequestTypeDef
def get_value() -> CreateEnvironmentRequestRequestTypeDef:
return {
"name": ...,
}
Definition
class CreateEnvironmentRequestRequestTypeDef(TypedDict):
name: str,
description: NotRequired[str],
kmsKeyId: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
federationMode: NotRequired[FederationModeType], # (1)
federationParameters: NotRequired[FederationParametersTypeDef], # (2)
superuserParameters: NotRequired[SuperuserParametersTypeDef], # (3)
dataBundles: NotRequired[Sequence[str]],
CreateEnvironmentResponseTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import CreateEnvironmentResponseTypeDef
def get_value() -> CreateEnvironmentResponseTypeDef:
return {
"environmentId": ...,
"environmentArn": ...,
"environmentUrl": ...,
"ResponseMetadata": ...,
}
Definition
class CreateEnvironmentResponseTypeDef(TypedDict):
environmentId: str,
environmentArn: str,
environmentUrl: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetEnvironmentResponseTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import GetEnvironmentResponseTypeDef
def get_value() -> GetEnvironmentResponseTypeDef:
return {
"environment": ...,
"ResponseMetadata": ...,
}
Definition
class GetEnvironmentResponseTypeDef(TypedDict):
environment: EnvironmentTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListEnvironmentsResponseTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import ListEnvironmentsResponseTypeDef
def get_value() -> ListEnvironmentsResponseTypeDef:
return {
"environments": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListEnvironmentsResponseTypeDef(TypedDict):
environments: List[EnvironmentTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateEnvironmentResponseTypeDef
Usage Example
from mypy_boto3_finspace.type_defs import UpdateEnvironmentResponseTypeDef
def get_value() -> UpdateEnvironmentResponseTypeDef:
return {
"environment": ...,
"ResponseMetadata": ...,
}