Typed dictionaries
Index > CodeStarconnections > Typed dictionaries
Auto-generated documentation for CodeStarconnections type annotations stubs module mypy-boto3-codestar-connections.
ConnectionTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ConnectionTypeDef
def get_value() -> ConnectionTypeDef:
return {
"ConnectionName": ...,
}
Definition
class ConnectionTypeDef(TypedDict):
ConnectionName: NotRequired[str],
ConnectionArn: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
OwnerAccountId: NotRequired[str],
ConnectionStatus: NotRequired[ConnectionStatusType], # (2)
HostArn: NotRequired[str],
- See ProviderTypeType
- See ConnectionStatusType
TagTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
"Value": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_codestar_connections.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,
VpcConfigurationTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import VpcConfigurationTypeDef
def get_value() -> VpcConfigurationTypeDef:
return {
"VpcId": ...,
"SubnetIds": ...,
"SecurityGroupIds": ...,
}
Definition
class VpcConfigurationTypeDef(TypedDict):
VpcId: str,
SubnetIds: Sequence[str],
SecurityGroupIds: Sequence[str],
TlsCertificate: NotRequired[str],
DeleteConnectionInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import DeleteConnectionInputRequestTypeDef
def get_value() -> DeleteConnectionInputRequestTypeDef:
return {
"ConnectionArn": ...,
}
DeleteHostInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import DeleteHostInputRequestTypeDef
def get_value() -> DeleteHostInputRequestTypeDef:
return {
"HostArn": ...,
}
GetConnectionInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import GetConnectionInputRequestTypeDef
def get_value() -> GetConnectionInputRequestTypeDef:
return {
"ConnectionArn": ...,
}
GetHostInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import GetHostInputRequestTypeDef
def get_value() -> GetHostInputRequestTypeDef:
return {
"HostArn": ...,
}
ListConnectionsInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListConnectionsInputRequestTypeDef
def get_value() -> ListConnectionsInputRequestTypeDef:
return {
"ProviderTypeFilter": ...,
}
Definition
class ListConnectionsInputRequestTypeDef(TypedDict):
ProviderTypeFilter: NotRequired[ProviderTypeType], # (1)
HostArnFilter: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
- See ProviderTypeType
ListHostsInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListHostsInputRequestTypeDef
def get_value() -> ListHostsInputRequestTypeDef:
return {
"MaxResults": ...,
}
Definition
class ListHostsInputRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListTagsForResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListTagsForResourceInputRequestTypeDef
def get_value() -> ListTagsForResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
}
UntagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"TagKeys": ...,
}
Definition
class UntagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
CreateConnectionInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import CreateConnectionInputRequestTypeDef
def get_value() -> CreateConnectionInputRequestTypeDef:
return {
"ConnectionName": ...,
}
Definition
class CreateConnectionInputRequestTypeDef(TypedDict):
ConnectionName: str,
ProviderType: NotRequired[ProviderTypeType], # (1)
Tags: NotRequired[Sequence[TagTypeDef]], # (2)
HostArn: NotRequired[str],
- See ProviderTypeType
- See TagTypeDef
TagResourceInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"ResourceArn": ...,
"Tags": ...,
}
Definition
class TagResourceInputRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateConnectionOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import CreateConnectionOutputTypeDef
def get_value() -> CreateConnectionOutputTypeDef:
return {
"ConnectionArn": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class CreateConnectionOutputTypeDef(TypedDict):
ConnectionArn: str,
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
CreateHostOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import CreateHostOutputTypeDef
def get_value() -> CreateHostOutputTypeDef:
return {
"HostArn": ...,
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class CreateHostOutputTypeDef(TypedDict):
HostArn: str,
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
GetConnectionOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import GetConnectionOutputTypeDef
def get_value() -> GetConnectionOutputTypeDef:
return {
"Connection": ...,
"ResponseMetadata": ...,
}
Definition
class GetConnectionOutputTypeDef(TypedDict):
Connection: ConnectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConnectionsOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListConnectionsOutputTypeDef
def get_value() -> ListConnectionsOutputTypeDef:
return {
"Connections": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListConnectionsOutputTypeDef(TypedDict):
Connections: List[ConnectionTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
CreateHostInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import CreateHostInputRequestTypeDef
def get_value() -> CreateHostInputRequestTypeDef:
return {
"Name": ...,
"ProviderType": ...,
"ProviderEndpoint": ...,
}
Definition
class CreateHostInputRequestTypeDef(TypedDict):
Name: str,
ProviderType: ProviderTypeType, # (1)
ProviderEndpoint: str,
VpcConfiguration: NotRequired[VpcConfigurationTypeDef], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (3)
- See ProviderTypeType
- See VpcConfigurationTypeDef
- See TagTypeDef
GetHostOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import GetHostOutputTypeDef
def get_value() -> GetHostOutputTypeDef:
return {
"Name": ...,
"Status": ...,
"ProviderType": ...,
"ProviderEndpoint": ...,
"VpcConfiguration": ...,
"ResponseMetadata": ...,
}
Definition
class GetHostOutputTypeDef(TypedDict):
Name: str,
Status: str,
ProviderType: ProviderTypeType, # (1)
ProviderEndpoint: str,
VpcConfiguration: VpcConfigurationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
HostTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import HostTypeDef
def get_value() -> HostTypeDef:
return {
"Name": ...,
}
Definition
class HostTypeDef(TypedDict):
Name: NotRequired[str],
HostArn: NotRequired[str],
ProviderType: NotRequired[ProviderTypeType], # (1)
ProviderEndpoint: NotRequired[str],
VpcConfiguration: NotRequired[VpcConfigurationTypeDef], # (2)
Status: NotRequired[str],
StatusMessage: NotRequired[str],
UpdateHostInputRequestTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import UpdateHostInputRequestTypeDef
def get_value() -> UpdateHostInputRequestTypeDef:
return {
"HostArn": ...,
}
Definition
class UpdateHostInputRequestTypeDef(TypedDict):
HostArn: str,
ProviderEndpoint: NotRequired[str],
VpcConfiguration: NotRequired[VpcConfigurationTypeDef], # (1)
ListHostsOutputTypeDef
Usage Example
from mypy_boto3_codestar_connections.type_defs import ListHostsOutputTypeDef
def get_value() -> ListHostsOutputTypeDef:
return {
"Hosts": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListHostsOutputTypeDef(TypedDict):
Hosts: List[HostTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See HostTypeDef
- See ResponseMetadataTypeDef