Skip to content

Type definitions#

Index > CodeCatalyst > Type definitions

Auto-generated documentation for CodeCatalyst type annotations stubs module mypy-boto3-codecatalyst.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AccessTokenSummaryTypeDef#

# AccessTokenSummaryTypeDef definition

class AccessTokenSummaryTypeDef(TypedDict):
    id: str,
    name: str,
    expiresTime: NotRequired[datetime],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

IdeConfigurationTypeDef#

# IdeConfigurationTypeDef definition

class IdeConfigurationTypeDef(TypedDict):
    runtime: NotRequired[str],
    name: NotRequired[str],

PersistentStorageConfigurationTypeDef#

# PersistentStorageConfigurationTypeDef definition

class PersistentStorageConfigurationTypeDef(TypedDict):
    sizeInGiB: int,

RepositoryInputTypeDef#

# RepositoryInputTypeDef definition

class RepositoryInputTypeDef(TypedDict):
    repositoryName: str,
    branchName: NotRequired[str],

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    spaceName: str,
    displayName: str,
    description: NotRequired[str],

CreateSourceRepositoryBranchRequestRequestTypeDef#

# CreateSourceRepositoryBranchRequestRequestTypeDef definition

class CreateSourceRepositoryBranchRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,
    name: str,
    headCommitId: NotRequired[str],

CreateSourceRepositoryRequestRequestTypeDef#

# CreateSourceRepositoryRequestRequestTypeDef definition

class CreateSourceRepositoryRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,
    description: NotRequired[str],

DeleteAccessTokenRequestRequestTypeDef#

# DeleteAccessTokenRequestRequestTypeDef definition

class DeleteAccessTokenRequestRequestTypeDef(TypedDict):
    id: str,

DeleteDevEnvironmentRequestRequestTypeDef#

# DeleteDevEnvironmentRequestRequestTypeDef definition

class DeleteDevEnvironmentRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    spaceName: str,
    name: str,

DeleteSourceRepositoryRequestRequestTypeDef#

# DeleteSourceRepositoryRequestRequestTypeDef definition

class DeleteSourceRepositoryRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,

DeleteSpaceRequestRequestTypeDef#

# DeleteSpaceRequestRequestTypeDef definition

class DeleteSpaceRequestRequestTypeDef(TypedDict):
    name: str,

DevEnvironmentAccessDetailsTypeDef#

# DevEnvironmentAccessDetailsTypeDef definition

class DevEnvironmentAccessDetailsTypeDef(TypedDict):
    streamUrl: str,
    tokenValue: str,

DevEnvironmentRepositorySummaryTypeDef#

# DevEnvironmentRepositorySummaryTypeDef definition

class DevEnvironmentRepositorySummaryTypeDef(TypedDict):
    repositoryName: str,
    branchName: NotRequired[str],

ExecuteCommandSessionConfigurationTypeDef#

# ExecuteCommandSessionConfigurationTypeDef definition

class ExecuteCommandSessionConfigurationTypeDef(TypedDict):
    command: str,
    arguments: NotRequired[Sequence[str]],

DevEnvironmentSessionSummaryTypeDef#

# DevEnvironmentSessionSummaryTypeDef definition

class DevEnvironmentSessionSummaryTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    devEnvironmentId: str,
    startedTime: datetime,
    id: str,

IdeTypeDef#

# IdeTypeDef definition

class IdeTypeDef(TypedDict):
    runtime: NotRequired[str],
    name: NotRequired[str],

PersistentStorageTypeDef#

# PersistentStorageTypeDef definition

class PersistentStorageTypeDef(TypedDict):
    sizeInGiB: int,

EmailAddressTypeDef#

# EmailAddressTypeDef definition

class EmailAddressTypeDef(TypedDict):
    email: NotRequired[str],
    verified: NotRequired[bool],

EventPayloadTypeDef#

# EventPayloadTypeDef definition

class EventPayloadTypeDef(TypedDict):
    contentType: NotRequired[str],
    data: NotRequired[str],

ProjectInformationTypeDef#

# ProjectInformationTypeDef definition

class ProjectInformationTypeDef(TypedDict):
    name: NotRequired[str],
    projectId: NotRequired[str],

UserIdentityTypeDef#

# UserIdentityTypeDef definition

class UserIdentityTypeDef(TypedDict):
    userType: UserTypeType,  # (1)
    principalId: str,
    userName: NotRequired[str],
    awsAccountId: NotRequired[str],
  1. See UserTypeType

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    key: str,
    values: Sequence[str],
    comparisonOperator: NotRequired[str],

GetDevEnvironmentRequestRequestTypeDef#

# GetDevEnvironmentRequestRequestTypeDef definition

class GetDevEnvironmentRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,

GetProjectRequestRequestTypeDef#

# GetProjectRequestRequestTypeDef definition

class GetProjectRequestRequestTypeDef(TypedDict):
    spaceName: str,
    name: str,

GetSourceRepositoryCloneUrlsRequestRequestTypeDef#

# GetSourceRepositoryCloneUrlsRequestRequestTypeDef definition

class GetSourceRepositoryCloneUrlsRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,

GetSourceRepositoryRequestRequestTypeDef#

# GetSourceRepositoryRequestRequestTypeDef definition

class GetSourceRepositoryRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,

GetSpaceRequestRequestTypeDef#

# GetSpaceRequestRequestTypeDef definition

class GetSpaceRequestRequestTypeDef(TypedDict):
    name: str,

GetSubscriptionRequestRequestTypeDef#

# GetSubscriptionRequestRequestTypeDef definition

class GetSubscriptionRequestRequestTypeDef(TypedDict):
    spaceName: str,

GetUserDetailsRequestRequestTypeDef#

# GetUserDetailsRequestRequestTypeDef definition

class GetUserDetailsRequestRequestTypeDef(TypedDict):
    id: NotRequired[str],
    userName: NotRequired[str],

GetWorkflowRequestRequestTypeDef#

# GetWorkflowRequestRequestTypeDef definition

class GetWorkflowRequestRequestTypeDef(TypedDict):
    spaceName: str,
    id: str,
    projectName: str,

WorkflowDefinitionTypeDef#

# WorkflowDefinitionTypeDef definition

class WorkflowDefinitionTypeDef(TypedDict):
    path: str,

GetWorkflowRunRequestRequestTypeDef#

# GetWorkflowRunRequestRequestTypeDef definition

class GetWorkflowRunRequestRequestTypeDef(TypedDict):
    spaceName: str,
    id: str,
    projectName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAccessTokensRequestRequestTypeDef#

# ListAccessTokensRequestRequestTypeDef definition

class ListAccessTokensRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListDevEnvironmentSessionsRequestRequestTypeDef#

# ListDevEnvironmentSessionsRequestRequestTypeDef definition

class ListDevEnvironmentSessionsRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    devEnvironmentId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ProjectListFilterTypeDef#

# ProjectListFilterTypeDef definition

class ProjectListFilterTypeDef(TypedDict):
    key: FilterKeyType,  # (1)
    values: Sequence[str],
    comparisonOperator: NotRequired[ComparisonOperatorType],  # (2)
  1. See FilterKeyType
  2. See ComparisonOperatorType

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    name: str,
    displayName: NotRequired[str],
    description: NotRequired[str],

ListSourceRepositoriesItemTypeDef#

# ListSourceRepositoriesItemTypeDef definition

class ListSourceRepositoriesItemTypeDef(TypedDict):
    id: str,
    name: str,
    lastUpdatedTime: datetime,
    createdTime: datetime,
    description: NotRequired[str],

ListSourceRepositoriesRequestRequestTypeDef#

# ListSourceRepositoriesRequestRequestTypeDef definition

class ListSourceRepositoriesRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListSourceRepositoryBranchesItemTypeDef#

# ListSourceRepositoryBranchesItemTypeDef definition

class ListSourceRepositoryBranchesItemTypeDef(TypedDict):
    ref: NotRequired[str],
    name: NotRequired[str],
    lastUpdatedTime: NotRequired[datetime],
    headCommitId: NotRequired[str],

ListSourceRepositoryBranchesRequestRequestTypeDef#

# ListSourceRepositoryBranchesRequestRequestTypeDef definition

class ListSourceRepositoryBranchesRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    sourceRepositoryName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListSpacesRequestRequestTypeDef#

# ListSpacesRequestRequestTypeDef definition

class ListSpacesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],

SpaceSummaryTypeDef#

# SpaceSummaryTypeDef definition

class SpaceSummaryTypeDef(TypedDict):
    name: str,
    regionName: str,
    displayName: NotRequired[str],
    description: NotRequired[str],

ListWorkflowRunsRequestRequestTypeDef#

# ListWorkflowRunsRequestRequestTypeDef definition

class ListWorkflowRunsRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    workflowId: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    sortBy: NotRequired[Sequence[Mapping[str, Any]]],

WorkflowRunSummaryTypeDef#

# WorkflowRunSummaryTypeDef definition

class WorkflowRunSummaryTypeDef(TypedDict):
    id: str,
    workflowId: str,
    workflowName: str,
    status: WorkflowRunStatusType,  # (1)
    startTime: datetime,
    lastUpdatedTime: datetime,
    statusReasons: NotRequired[List[Dict[str, Any]]],
    endTime: NotRequired[datetime],
  1. See WorkflowRunStatusType

ListWorkflowsRequestRequestTypeDef#

# ListWorkflowsRequestRequestTypeDef definition

class ListWorkflowsRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    sortBy: NotRequired[Sequence[Mapping[str, Any]]],

StartWorkflowRunRequestRequestTypeDef#

# StartWorkflowRunRequestRequestTypeDef definition

class StartWorkflowRunRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    workflowId: str,
    clientToken: NotRequired[str],

StopDevEnvironmentRequestRequestTypeDef#

# StopDevEnvironmentRequestRequestTypeDef definition

class StopDevEnvironmentRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,

StopDevEnvironmentSessionRequestRequestTypeDef#

# StopDevEnvironmentSessionRequestRequestTypeDef definition

class StopDevEnvironmentSessionRequestRequestTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,
    sessionId: str,

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

class UpdateProjectRequestRequestTypeDef(TypedDict):
    spaceName: str,
    name: str,
    description: NotRequired[str],

UpdateSpaceRequestRequestTypeDef#

# UpdateSpaceRequestRequestTypeDef definition

class UpdateSpaceRequestRequestTypeDef(TypedDict):
    name: str,
    description: NotRequired[str],

WorkflowDefinitionSummaryTypeDef#

# WorkflowDefinitionSummaryTypeDef definition

class WorkflowDefinitionSummaryTypeDef(TypedDict):
    path: str,

CreateAccessTokenRequestRequestTypeDef#

# CreateAccessTokenRequestRequestTypeDef definition

class CreateAccessTokenRequestRequestTypeDef(TypedDict):
    name: str,
    expiresTime: NotRequired[Union[datetime, str]],

ListEventLogsRequestRequestTypeDef#

# ListEventLogsRequestRequestTypeDef definition

class ListEventLogsRequestRequestTypeDef(TypedDict):
    spaceName: str,
    startTime: Union[datetime, str],
    endTime: Union[datetime, str],
    eventName: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

CreateAccessTokenResponseTypeDef#

# CreateAccessTokenResponseTypeDef definition

class CreateAccessTokenResponseTypeDef(TypedDict):
    secret: str,
    name: str,
    expiresTime: datetime,
    accessTokenId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDevEnvironmentResponseTypeDef#

# CreateDevEnvironmentResponseTypeDef definition

class CreateDevEnvironmentResponseTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,
    vpcConnectionName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

class CreateProjectResponseTypeDef(TypedDict):
    spaceName: str,
    name: str,
    displayName: str,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSourceRepositoryBranchResponseTypeDef#

# CreateSourceRepositoryBranchResponseTypeDef definition

class CreateSourceRepositoryBranchResponseTypeDef(TypedDict):
    ref: str,
    name: str,
    lastUpdatedTime: datetime,
    headCommitId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSourceRepositoryResponseTypeDef#

# CreateSourceRepositoryResponseTypeDef definition

class CreateSourceRepositoryResponseTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDevEnvironmentResponseTypeDef#

# DeleteDevEnvironmentResponseTypeDef definition

class DeleteDevEnvironmentResponseTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProjectResponseTypeDef#

# DeleteProjectResponseTypeDef definition

class DeleteProjectResponseTypeDef(TypedDict):
    spaceName: str,
    name: str,
    displayName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSourceRepositoryResponseTypeDef#

# DeleteSourceRepositoryResponseTypeDef definition

class DeleteSourceRepositoryResponseTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteSpaceResponseTypeDef#

# DeleteSpaceResponseTypeDef definition

class DeleteSpaceResponseTypeDef(TypedDict):
    name: str,
    displayName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetProjectResponseTypeDef#

# GetProjectResponseTypeDef definition

class GetProjectResponseTypeDef(TypedDict):
    spaceName: str,
    name: str,
    displayName: str,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSourceRepositoryCloneUrlsResponseTypeDef#

# GetSourceRepositoryCloneUrlsResponseTypeDef definition

class GetSourceRepositoryCloneUrlsResponseTypeDef(TypedDict):
    https: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSourceRepositoryResponseTypeDef#

# GetSourceRepositoryResponseTypeDef definition

class GetSourceRepositoryResponseTypeDef(TypedDict):
    spaceName: str,
    projectName: str,
    name: str,
    description: str,
    lastUpdatedTime: datetime,
    createdTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSpaceResponseTypeDef#

# GetSpaceResponseTypeDef definition

class GetSpaceResponseTypeDef(TypedDict):
    name: str,
    regionName: str,
    displayName: str,
    description: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetSubscriptionResponseTypeDef#

# GetSubscriptionResponseTypeDef definition

class GetSubscriptionResponseTypeDef(TypedDict):
    subscriptionType: str,
    awsAccountName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef
  2. <