Skip to content

Type definitions#

Index > CodeStar > Type definitions

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

AssociateTeamMemberRequestRequestTypeDef#

# AssociateTeamMemberRequestRequestTypeDef definition

class AssociateTeamMemberRequestRequestTypeDef(TypedDict):
    projectId: str,
    userArn: str,
    projectRole: str,
    clientRequestToken: NotRequired[str],
    remoteAccessAllowed: NotRequired[bool],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

CodeCommitCodeDestinationTypeDef#

# CodeCommitCodeDestinationTypeDef definition

class CodeCommitCodeDestinationTypeDef(TypedDict):
    name: str,

GitHubCodeDestinationTypeDef#

# GitHubCodeDestinationTypeDef definition

class GitHubCodeDestinationTypeDef(TypedDict):
    name: str,
    type: str,
    owner: str,
    privateRepository: bool,
    issuesEnabled: bool,
    token: str,
    description: NotRequired[str],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucketName: NotRequired[str],
    bucketKey: NotRequired[str],

CreateUserProfileRequestRequestTypeDef#

# CreateUserProfileRequestRequestTypeDef definition

class CreateUserProfileRequestRequestTypeDef(TypedDict):
    userArn: str,
    displayName: str,
    emailAddress: str,
    sshPublicKey: NotRequired[str],

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    id: str,
    clientRequestToken: NotRequired[str],
    deleteStack: NotRequired[bool],

DeleteUserProfileRequestRequestTypeDef#

# DeleteUserProfileRequestRequestTypeDef definition

class DeleteUserProfileRequestRequestTypeDef(TypedDict):
    userArn: str,

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    id: str,

ProjectStatusTypeDef#

# ProjectStatusTypeDef definition

class ProjectStatusTypeDef(TypedDict):
    state: str,
    reason: NotRequired[str],

DescribeUserProfileRequestRequestTypeDef#

# DescribeUserProfileRequestRequestTypeDef definition

class DescribeUserProfileRequestRequestTypeDef(TypedDict):
    userArn: str,

DisassociateTeamMemberRequestRequestTypeDef#

# DisassociateTeamMemberRequestRequestTypeDef definition

class DisassociateTeamMemberRequestRequestTypeDef(TypedDict):
    projectId: str,
    userArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

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

ProjectSummaryTypeDef#

# ProjectSummaryTypeDef definition

class ProjectSummaryTypeDef(TypedDict):
    projectId: NotRequired[str],
    projectArn: NotRequired[str],

ListResourcesRequestRequestTypeDef#

# ListResourcesRequestRequestTypeDef definition

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

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    id: str,

ListTagsForProjectRequestRequestTypeDef#

# ListTagsForProjectRequestRequestTypeDef definition

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

ListTeamMembersRequestRequestTypeDef#

# ListTeamMembersRequestRequestTypeDef definition

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

TeamMemberTypeDef#

# TeamMemberTypeDef definition

class TeamMemberTypeDef(TypedDict):
    userArn: str,
    projectRole: str,
    remoteAccessAllowed: NotRequired[bool],

ListUserProfilesRequestRequestTypeDef#

# ListUserProfilesRequestRequestTypeDef definition

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

UserProfileSummaryTypeDef#

# UserProfileSummaryTypeDef definition

class UserProfileSummaryTypeDef(TypedDict):
    userArn: NotRequired[str],
    displayName: NotRequired[str],
    emailAddress: NotRequired[str],
    sshPublicKey: NotRequired[str],

TagProjectRequestRequestTypeDef#

# TagProjectRequestRequestTypeDef definition

class TagProjectRequestRequestTypeDef(TypedDict):
    id: str,
    tags: Mapping[str, str],

UntagProjectRequestRequestTypeDef#

# UntagProjectRequestRequestTypeDef definition

class UntagProjectRequestRequestTypeDef(TypedDict):
    id: str,
    tags: Sequence[str],

UpdateProjectRequestRequestTypeDef#

# UpdateProjectRequestRequestTypeDef definition

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

UpdateTeamMemberRequestRequestTypeDef#

# UpdateTeamMemberRequestRequestTypeDef definition

class UpdateTeamMemberRequestRequestTypeDef(TypedDict):
    projectId: str,
    userArn: str,
    projectRole: NotRequired[str],
    remoteAccessAllowed: NotRequired[bool],

UpdateUserProfileRequestRequestTypeDef#

# UpdateUserProfileRequestRequestTypeDef definition

class UpdateUserProfileRequestRequestTypeDef(TypedDict):
    userArn: str,
    displayName: NotRequired[str],
    emailAddress: NotRequired[str],
    sshPublicKey: NotRequired[str],

AssociateTeamMemberResultTypeDef#

# AssociateTeamMemberResultTypeDef definition

class AssociateTeamMemberResultTypeDef(TypedDict):
    clientRequestToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateProjectResultTypeDef#

# CreateProjectResultTypeDef definition

class CreateProjectResultTypeDef(TypedDict):
    id: str,
    arn: str,
    clientRequestToken: str,
    projectTemplateId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserProfileResultTypeDef#

# CreateUserProfileResultTypeDef definition

class CreateUserProfileResultTypeDef(TypedDict):
    userArn: str,
    displayName: str,
    emailAddress: str,
    sshPublicKey: str,
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProjectResultTypeDef#

# DeleteProjectResultTypeDef definition

class DeleteProjectResultTypeDef(TypedDict):
    stackId: str,
    projectArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteUserProfileResultTypeDef#

# DeleteUserProfileResultTypeDef definition

class DeleteUserProfileResultTypeDef(TypedDict):
    userArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeUserProfileResultTypeDef#

# DescribeUserProfileResultTypeDef definition

class DescribeUserProfileResultTypeDef(TypedDict):
    userArn: str,
    displayName: str,
    emailAddress: str,
    sshPublicKey: str,
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForProjectResultTypeDef#

# ListTagsForProjectResultTypeDef definition

class ListTagsForProjectResultTypeDef(TypedDict):
    tags: Dict[str, str],
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

TagProjectResultTypeDef#

# TagProjectResultTypeDef definition

class TagProjectResultTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateTeamMemberResultTypeDef#

# UpdateTeamMemberResultTypeDef definition

class UpdateTeamMemberResultTypeDef(TypedDict):
    userArn: str,
    projectRole: str,
    remoteAccessAllowed: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateUserProfileResultTypeDef#

# UpdateUserProfileResultTypeDef definition

class UpdateUserProfileResultTypeDef(TypedDict):
    userArn: str,
    displayName: str,
    emailAddress: str,
    sshPublicKey: str,
    createdTimestamp: datetime,
    lastModifiedTimestamp: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CodeDestinationTypeDef#

# CodeDestinationTypeDef definition

class CodeDestinationTypeDef(TypedDict):
    codeCommit: NotRequired[CodeCommitCodeDestinationTypeDef],  # (1)
    gitHub: NotRequired[GitHubCodeDestinationTypeDef],  # (2)
  1. See CodeCommitCodeDestinationTypeDef
  2. See GitHubCodeDestinationTypeDef

CodeSourceTypeDef#

# CodeSourceTypeDef definition

class CodeSourceTypeDef(TypedDict):
    s3: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

ToolchainSourceTypeDef#

# ToolchainSourceTypeDef definition

class ToolchainSourceTypeDef(TypedDict):
    s3: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

DescribeProjectResultTypeDef#

# DescribeProjectResultTypeDef definition

class DescribeProjectResultTypeDef(TypedDict):
    name: str,
    id: str,
    arn: str,
    description: str,
    clientRequestToken: str,
    createdTimeStamp: datetime,
    stackId: str,
    projectTemplateId: str,
    status: ProjectStatusTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectStatusTypeDef
  2. See ResponseMetadataTypeDef

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef definition

class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListResourcesRequestListResourcesPaginateTypeDef#

# ListResourcesRequestListResourcesPaginateTypeDef definition

class ListResourcesRequestListResourcesPaginateTypeDef(TypedDict):
    projectId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTeamMembersRequestListTeamMembersPaginateTypeDef#

# ListTeamMembersRequestListTeamMembersPaginateTypeDef definition

class ListTeamMembersRequestListTeamMembersPaginateTypeDef(TypedDict):
    projectId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListUserProfilesRequestListUserProfilesPaginateTypeDef#

# ListUserProfilesRequestListUserProfilesPaginateTypeDef definition

class ListUserProfilesRequestListUserProfilesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectsResultTypeDef#

# ListProjectsResultTypeDef definition

class ListProjectsResultTypeDef(TypedDict):
    projects: List[ProjectSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListResourcesResultTypeDef#

# ListResourcesResultTypeDef definition

class ListResourcesResultTypeDef(TypedDict):
    resources: List[ResourceTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourceTypeDef
  2. See ResponseMetadataTypeDef

ListTeamMembersResultTypeDef#

# ListTeamMembersResultTypeDef definition

class ListTeamMembersResultTypeDef(TypedDict):
    teamMembers: List[TeamMemberTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TeamMemberTypeDef
  2. See ResponseMetadataTypeDef

ListUserProfilesResultTypeDef#

# ListUserProfilesResultTypeDef definition

class ListUserProfilesResultTypeDef(TypedDict):
    userProfiles: List[UserProfileSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserProfileSummaryTypeDef
  2. See ResponseMetadataTypeDef

CodeTypeDef#

# CodeTypeDef definition

class CodeTypeDef(TypedDict):
    source: CodeSourceTypeDef,  # (1)
    destination: CodeDestinationTypeDef,  # (2)
  1. See CodeSourceTypeDef
  2. See CodeDestinationTypeDef

ToolchainTypeDef#

# ToolchainTypeDef definition

class ToolchainTypeDef(TypedDict):
    source: ToolchainSourceTypeDef,  # (1)
    roleArn: NotRequired[str],
    stackParameters: NotRequired[Mapping[str, str]],
  1. See ToolchainSourceTypeDef

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    name: str,
    id: str,
    description: NotRequired[str],
    clientRequestToken: NotRequired[str],
    sourceCode: NotRequired[Sequence[CodeTypeDef]],  # (1)
    toolchain: NotRequired[ToolchainTypeDef],  # (2)
    tags: NotRequired[Mapping[str, str]],
  1. See CodeTypeDef
  2. See ToolchainTypeDef