Skip to content

Typed dictionaries#

Index > CodeStarconnections > Typed dictionaries

Auto-generated documentation for CodeStarconnections type annotations stubs module mypy-boto3-codestar-connections.

ConnectionTypeDef#

# ConnectionTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ConnectionTypeDef

def get_value() -> ConnectionTypeDef:
    return {
        "ConnectionName": ...,
    }
# ConnectionTypeDef definition

class ConnectionTypeDef(TypedDict):
    ConnectionName: NotRequired[str],
    ConnectionArn: NotRequired[str],
    ProviderType: NotRequired[ProviderTypeType],  # (1)
    OwnerAccountId: NotRequired[str],
    ConnectionStatus: NotRequired[ConnectionStatusType],  # (2)
    HostArn: NotRequired[str],
  1. See ProviderTypeType
  2. See ConnectionStatusType

TagTypeDef#

# TagTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }
# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

VpcConfigurationTypeDef#

# VpcConfigurationTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import VpcConfigurationTypeDef

def get_value() -> VpcConfigurationTypeDef:
    return {
        "VpcId": ...,
        "SubnetIds": ...,
        "SecurityGroupIds": ...,
    }
# VpcConfigurationTypeDef definition

class VpcConfigurationTypeDef(TypedDict):
    VpcId: str,
    SubnetIds: Sequence[str],
    SecurityGroupIds: Sequence[str],
    TlsCertificate: NotRequired[str],

DeleteConnectionInputRequestTypeDef#

# DeleteConnectionInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import DeleteConnectionInputRequestTypeDef

def get_value() -> DeleteConnectionInputRequestTypeDef:
    return {
        "ConnectionArn": ...,
    }
# DeleteConnectionInputRequestTypeDef definition

class DeleteConnectionInputRequestTypeDef(TypedDict):
    ConnectionArn: str,

DeleteHostInputRequestTypeDef#

# DeleteHostInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import DeleteHostInputRequestTypeDef

def get_value() -> DeleteHostInputRequestTypeDef:
    return {
        "HostArn": ...,
    }
# DeleteHostInputRequestTypeDef definition

class DeleteHostInputRequestTypeDef(TypedDict):
    HostArn: str,

GetConnectionInputRequestTypeDef#

# GetConnectionInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import GetConnectionInputRequestTypeDef

def get_value() -> GetConnectionInputRequestTypeDef:
    return {
        "ConnectionArn": ...,
    }
# GetConnectionInputRequestTypeDef definition

class GetConnectionInputRequestTypeDef(TypedDict):
    ConnectionArn: str,

GetHostInputRequestTypeDef#

# GetHostInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import GetHostInputRequestTypeDef

def get_value() -> GetHostInputRequestTypeDef:
    return {
        "HostArn": ...,
    }
# GetHostInputRequestTypeDef definition

class GetHostInputRequestTypeDef(TypedDict):
    HostArn: str,

ListConnectionsInputRequestTypeDef#

# ListConnectionsInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListConnectionsInputRequestTypeDef

def get_value() -> ListConnectionsInputRequestTypeDef:
    return {
        "ProviderTypeFilter": ...,
    }
# ListConnectionsInputRequestTypeDef definition

class ListConnectionsInputRequestTypeDef(TypedDict):
    ProviderTypeFilter: NotRequired[ProviderTypeType],  # (1)
    HostArnFilter: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ProviderTypeType

ListHostsInputRequestTypeDef#

# ListHostsInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListHostsInputRequestTypeDef

def get_value() -> ListHostsInputRequestTypeDef:
    return {
        "MaxResults": ...,
    }
# ListHostsInputRequestTypeDef definition

class ListHostsInputRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

GetConnectionOutputTypeDef#

# GetConnectionOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import GetConnectionOutputTypeDef

def get_value() -> GetConnectionOutputTypeDef:
    return {
        "Connection": ...,
        "ResponseMetadata": ...,
    }
# GetConnectionOutputTypeDef definition

class GetConnectionOutputTypeDef(TypedDict):
    Connection: ConnectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

ListConnectionsOutputTypeDef#

# ListConnectionsOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListConnectionsOutputTypeDef

def get_value() -> ListConnectionsOutputTypeDef:
    return {
        "Connections": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListConnectionsOutputTypeDef definition

class ListConnectionsOutputTypeDef(TypedDict):
    Connections: List[ConnectionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConnectionTypeDef
  2. See ResponseMetadataTypeDef

CreateConnectionInputRequestTypeDef#

# CreateConnectionInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import CreateConnectionInputRequestTypeDef

def get_value() -> CreateConnectionInputRequestTypeDef:
    return {
        "ConnectionName": ...,
    }
# CreateConnectionInputRequestTypeDef definition

class CreateConnectionInputRequestTypeDef(TypedDict):
    ConnectionName: str,
    ProviderType: NotRequired[ProviderTypeType],  # (1)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    HostArn: NotRequired[str],
  1. See ProviderTypeType
  2. See TagTypeDef

CreateConnectionOutputTypeDef#

# CreateConnectionOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import CreateConnectionOutputTypeDef

def get_value() -> CreateConnectionOutputTypeDef:
    return {
        "ConnectionArn": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# CreateConnectionOutputTypeDef definition

class CreateConnectionOutputTypeDef(TypedDict):
    ConnectionArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

CreateHostOutputTypeDef#

# CreateHostOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import CreateHostOutputTypeDef

def get_value() -> CreateHostOutputTypeDef:
    return {
        "HostArn": ...,
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# CreateHostOutputTypeDef definition

class CreateHostOutputTypeDef(TypedDict):
    HostArn: str,
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListTagsForResourceOutputTypeDef

def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateHostInputRequestTypeDef#

# CreateHostInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import CreateHostInputRequestTypeDef

def get_value() -> CreateHostInputRequestTypeDef:
    return {
        "Name": ...,
        "ProviderType": ...,
        "ProviderEndpoint": ...,
    }
# CreateHostInputRequestTypeDef definition

class CreateHostInputRequestTypeDef(TypedDict):
    Name: str,
    ProviderType: ProviderTypeType,  # (1)
    ProviderEndpoint: str,
    VpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See ProviderTypeType
  2. See VpcConfigurationTypeDef
  3. See TagTypeDef

GetHostOutputTypeDef#

# GetHostOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import GetHostOutputTypeDef

def get_value() -> GetHostOutputTypeDef:
    return {
        "Name": ...,
        "Status": ...,
        "ProviderType": ...,
        "ProviderEndpoint": ...,
        "VpcConfiguration": ...,
        "ResponseMetadata": ...,
    }
# GetHostOutputTypeDef definition

class GetHostOutputTypeDef(TypedDict):
    Name: str,
    Status: str,
    ProviderType: ProviderTypeType,  # (1)
    ProviderEndpoint: str,
    VpcConfiguration: VpcConfigurationTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ProviderTypeType
  2. See VpcConfigurationTypeDef
  3. See ResponseMetadataTypeDef

HostTypeDef#

# HostTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import HostTypeDef

def get_value() -> HostTypeDef:
    return {
        "Name": ...,
    }
# HostTypeDef 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],
  1. See ProviderTypeType
  2. See VpcConfigurationTypeDef

UpdateHostInputRequestTypeDef#

# UpdateHostInputRequestTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import UpdateHostInputRequestTypeDef

def get_value() -> UpdateHostInputRequestTypeDef:
    return {
        "HostArn": ...,
    }
# UpdateHostInputRequestTypeDef definition

class UpdateHostInputRequestTypeDef(TypedDict):
    HostArn: str,
    ProviderEndpoint: NotRequired[str],
    VpcConfiguration: NotRequired[VpcConfigurationTypeDef],  # (1)
  1. See VpcConfigurationTypeDef

ListHostsOutputTypeDef#

# ListHostsOutputTypeDef usage example

from mypy_boto3_codestar_connections.type_defs import ListHostsOutputTypeDef

def get_value() -> ListHostsOutputTypeDef:
    return {
        "Hosts": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListHostsOutputTypeDef definition

class ListHostsOutputTypeDef(TypedDict):
    Hosts: List[HostTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HostTypeDef
  2. See ResponseMetadataTypeDef