Typed dictionaries
Auto-generated documentation for CodeStar type annotations stubs module mypy-boto3-codestar.
AssociateTeamMemberRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import AssociateTeamMemberRequestRequestTypeDef
def get_value() -> AssociateTeamMemberRequestRequestTypeDef:
return {
"projectId": ...,
"userArn": ...,
"projectRole": ...,
}
Definition
class AssociateTeamMemberRequestRequestTypeDef(TypedDict):
projectId: str,
userArn: str,
projectRole: str,
clientRequestToken: NotRequired[str],
remoteAccessAllowed: NotRequired[bool],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_codestar.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,
CodeCommitCodeDestinationTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CodeCommitCodeDestinationTypeDef
def get_value() -> CodeCommitCodeDestinationTypeDef:
return {
"name": ...,
}
GitHubCodeDestinationTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import GitHubCodeDestinationTypeDef
def get_value() -> GitHubCodeDestinationTypeDef:
return {
"name": ...,
"type": ...,
"owner": ...,
"privateRepository": ...,
"issuesEnabled": ...,
"token": ...,
}
Definition
class GitHubCodeDestinationTypeDef(TypedDict):
name: str,
type: str,
owner: str,
privateRepository: bool,
issuesEnabled: bool,
token: str,
description: NotRequired[str],
S3LocationTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucketName": ...,
}
Definition
class S3LocationTypeDef(TypedDict):
bucketName: NotRequired[str],
bucketKey: NotRequired[str],
CreateUserProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CreateUserProfileRequestRequestTypeDef
def get_value() -> CreateUserProfileRequestRequestTypeDef:
return {
"userArn": ...,
"displayName": ...,
"emailAddress": ...,
}
Definition
class CreateUserProfileRequestRequestTypeDef(TypedDict):
userArn: str,
displayName: str,
emailAddress: str,
sshPublicKey: NotRequired[str],
DeleteProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DeleteProjectRequestRequestTypeDef
def get_value() -> DeleteProjectRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class DeleteProjectRequestRequestTypeDef(TypedDict):
id: str,
clientRequestToken: NotRequired[str],
deleteStack: NotRequired[bool],
DeleteUserProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DeleteUserProfileRequestRequestTypeDef
def get_value() -> DeleteUserProfileRequestRequestTypeDef:
return {
"userArn": ...,
}
DescribeProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DescribeProjectRequestRequestTypeDef
def get_value() -> DescribeProjectRequestRequestTypeDef:
return {
"id": ...,
}
ProjectStatusTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ProjectStatusTypeDef
def get_value() -> ProjectStatusTypeDef:
return {
"state": ...,
}
DescribeUserProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DescribeUserProfileRequestRequestTypeDef
def get_value() -> DescribeUserProfileRequestRequestTypeDef:
return {
"userArn": ...,
}
DisassociateTeamMemberRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DisassociateTeamMemberRequestRequestTypeDef
def get_value() -> DisassociateTeamMemberRequestRequestTypeDef:
return {
"projectId": ...,
"userArn": ...,
}
Definition
class DisassociateTeamMemberRequestRequestTypeDef(TypedDict):
projectId: str,
userArn: str,
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListProjectsRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListProjectsRequestRequestTypeDef
def get_value() -> ListProjectsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListProjectsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ProjectSummaryTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ProjectSummaryTypeDef
def get_value() -> ProjectSummaryTypeDef:
return {
"projectId": ...,
}
Definition
class ProjectSummaryTypeDef(TypedDict):
projectId: NotRequired[str],
projectArn: NotRequired[str],
ListResourcesRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListResourcesRequestRequestTypeDef
def get_value() -> ListResourcesRequestRequestTypeDef:
return {
"projectId": ...,
}
Definition
class ListResourcesRequestRequestTypeDef(TypedDict):
projectId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ResourceTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ResourceTypeDef
def get_value() -> ResourceTypeDef:
return {
"id": ...,
}
ListTagsForProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListTagsForProjectRequestRequestTypeDef
def get_value() -> ListTagsForProjectRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class ListTagsForProjectRequestRequestTypeDef(TypedDict):
id: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListTeamMembersRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListTeamMembersRequestRequestTypeDef
def get_value() -> ListTeamMembersRequestRequestTypeDef:
return {
"projectId": ...,
}
Definition
class ListTeamMembersRequestRequestTypeDef(TypedDict):
projectId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
TeamMemberTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import TeamMemberTypeDef
def get_value() -> TeamMemberTypeDef:
return {
"userArn": ...,
"projectRole": ...,
}
Definition
class TeamMemberTypeDef(TypedDict):
userArn: str,
projectRole: str,
remoteAccessAllowed: NotRequired[bool],
ListUserProfilesRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListUserProfilesRequestRequestTypeDef
def get_value() -> ListUserProfilesRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListUserProfilesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
UserProfileSummaryTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UserProfileSummaryTypeDef
def get_value() -> UserProfileSummaryTypeDef:
return {
"userArn": ...,
}
Definition
class UserProfileSummaryTypeDef(TypedDict):
userArn: NotRequired[str],
displayName: NotRequired[str],
emailAddress: NotRequired[str],
sshPublicKey: NotRequired[str],
TagProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import TagProjectRequestRequestTypeDef
def get_value() -> TagProjectRequestRequestTypeDef:
return {
"id": ...,
"tags": ...,
}
UntagProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UntagProjectRequestRequestTypeDef
def get_value() -> UntagProjectRequestRequestTypeDef:
return {
"id": ...,
"tags": ...,
}
UpdateProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UpdateProjectRequestRequestTypeDef
def get_value() -> UpdateProjectRequestRequestTypeDef:
return {
"id": ...,
}
Definition
class UpdateProjectRequestRequestTypeDef(TypedDict):
id: str,
name: NotRequired[str],
description: NotRequired[str],
UpdateTeamMemberRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UpdateTeamMemberRequestRequestTypeDef
def get_value() -> UpdateTeamMemberRequestRequestTypeDef:
return {
"projectId": ...,
"userArn": ...,
}
Definition
class UpdateTeamMemberRequestRequestTypeDef(TypedDict):
projectId: str,
userArn: str,
projectRole: NotRequired[str],
remoteAccessAllowed: NotRequired[bool],
UpdateUserProfileRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UpdateUserProfileRequestRequestTypeDef
def get_value() -> UpdateUserProfileRequestRequestTypeDef:
return {
"userArn": ...,
}
Definition
class UpdateUserProfileRequestRequestTypeDef(TypedDict):
userArn: str,
displayName: NotRequired[str],
emailAddress: NotRequired[str],
sshPublicKey: NotRequired[str],
AssociateTeamMemberResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import AssociateTeamMemberResultTypeDef
def get_value() -> AssociateTeamMemberResultTypeDef:
return {
"clientRequestToken": ...,
"ResponseMetadata": ...,
}
Definition
class AssociateTeamMemberResultTypeDef(TypedDict):
clientRequestToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProjectResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CreateProjectResultTypeDef
def get_value() -> CreateProjectResultTypeDef:
return {
"id": ...,
"arn": ...,
"clientRequestToken": ...,
"projectTemplateId": ...,
"ResponseMetadata": ...,
}
Definition
class CreateProjectResultTypeDef(TypedDict):
id: str,
arn: str,
clientRequestToken: str,
projectTemplateId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserProfileResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CreateUserProfileResultTypeDef
def get_value() -> CreateUserProfileResultTypeDef:
return {
"userArn": ...,
"displayName": ...,
"emailAddress": ...,
"sshPublicKey": ...,
"createdTimestamp": ...,
"lastModifiedTimestamp": ...,
"ResponseMetadata": ...,
}
Definition
class CreateUserProfileResultTypeDef(TypedDict):
userArn: str,
displayName: str,
emailAddress: str,
sshPublicKey: str,
createdTimestamp: datetime,
lastModifiedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteProjectResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DeleteProjectResultTypeDef
def get_value() -> DeleteProjectResultTypeDef:
return {
"stackId": ...,
"projectArn": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteProjectResultTypeDef(TypedDict):
stackId: str,
projectArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteUserProfileResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DeleteUserProfileResultTypeDef
def get_value() -> DeleteUserProfileResultTypeDef:
return {
"userArn": ...,
"ResponseMetadata": ...,
}
Definition
class DeleteUserProfileResultTypeDef(TypedDict):
userArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeUserProfileResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DescribeUserProfileResultTypeDef
def get_value() -> DescribeUserProfileResultTypeDef:
return {
"userArn": ...,
"displayName": ...,
"emailAddress": ...,
"sshPublicKey": ...,
"createdTimestamp": ...,
"lastModifiedTimestamp": ...,
"ResponseMetadata": ...,
}
Definition
class DescribeUserProfileResultTypeDef(TypedDict):
userArn: str,
displayName: str,
emailAddress: str,
sshPublicKey: str,
createdTimestamp: datetime,
lastModifiedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForProjectResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListTagsForProjectResultTypeDef
def get_value() -> ListTagsForProjectResultTypeDef:
return {
"tags": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTagsForProjectResultTypeDef(TypedDict):
tags: Dict[str, str],
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagProjectResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import TagProjectResultTypeDef
def get_value() -> TagProjectResultTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
Definition
class TagProjectResultTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateTeamMemberResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UpdateTeamMemberResultTypeDef
def get_value() -> UpdateTeamMemberResultTypeDef:
return {
"userArn": ...,
"projectRole": ...,
"remoteAccessAllowed": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateTeamMemberResultTypeDef(TypedDict):
userArn: str,
projectRole: str,
remoteAccessAllowed: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateUserProfileResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import UpdateUserProfileResultTypeDef
def get_value() -> UpdateUserProfileResultTypeDef:
return {
"userArn": ...,
"displayName": ...,
"emailAddress": ...,
"sshPublicKey": ...,
"createdTimestamp": ...,
"lastModifiedTimestamp": ...,
"ResponseMetadata": ...,
}
Definition
class UpdateUserProfileResultTypeDef(TypedDict):
userArn: str,
displayName: str,
emailAddress: str,
sshPublicKey: str,
createdTimestamp: datetime,
lastModifiedTimestamp: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CodeDestinationTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CodeDestinationTypeDef
def get_value() -> CodeDestinationTypeDef:
return {
"codeCommit": ...,
}
Definition
class CodeDestinationTypeDef(TypedDict):
codeCommit: NotRequired[CodeCommitCodeDestinationTypeDef], # (1)
gitHub: NotRequired[GitHubCodeDestinationTypeDef], # (2)
CodeSourceTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CodeSourceTypeDef
def get_value() -> CodeSourceTypeDef:
return {
"s3": ...,
}
ToolchainSourceTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ToolchainSourceTypeDef
def get_value() -> ToolchainSourceTypeDef:
return {
"s3": ...,
}
DescribeProjectResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import DescribeProjectResultTypeDef
def get_value() -> DescribeProjectResultTypeDef:
return {
"name": ...,
"id": ...,
"arn": ...,
"description": ...,
"clientRequestToken": ...,
"createdTimeStamp": ...,
"stackId": ...,
"projectTemplateId": ...,
"status": ...,
"ResponseMetadata": ...,
}
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)
ListProjectsRequestListProjectsPaginateTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListProjectsRequestListProjectsPaginateTypeDef
def get_value() -> ListProjectsRequestListProjectsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListResourcesRequestListResourcesPaginateTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListResourcesRequestListResourcesPaginateTypeDef
def get_value() -> ListResourcesRequestListResourcesPaginateTypeDef:
return {
"projectId": ...,
}
Definition
class ListResourcesRequestListResourcesPaginateTypeDef(TypedDict):
projectId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListTeamMembersRequestListTeamMembersPaginateTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListTeamMembersRequestListTeamMembersPaginateTypeDef
def get_value() -> ListTeamMembersRequestListTeamMembersPaginateTypeDef:
return {
"projectId": ...,
}
Definition
class ListTeamMembersRequestListTeamMembersPaginateTypeDef(TypedDict):
projectId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUserProfilesRequestListUserProfilesPaginateTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListUserProfilesRequestListUserProfilesPaginateTypeDef
def get_value() -> ListUserProfilesRequestListUserProfilesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
Definition
class ListUserProfilesRequestListUserProfilesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListProjectsResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListProjectsResultTypeDef
def get_value() -> ListProjectsResultTypeDef:
return {
"projects": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListProjectsResultTypeDef(TypedDict):
projects: List[ProjectSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListResourcesResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListResourcesResultTypeDef
def get_value() -> ListResourcesResultTypeDef:
return {
"resources": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListResourcesResultTypeDef(TypedDict):
resources: List[ResourceTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTeamMembersResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListTeamMembersResultTypeDef
def get_value() -> ListTeamMembersResultTypeDef:
return {
"teamMembers": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListTeamMembersResultTypeDef(TypedDict):
teamMembers: List[TeamMemberTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUserProfilesResultTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ListUserProfilesResultTypeDef
def get_value() -> ListUserProfilesResultTypeDef:
return {
"userProfiles": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
Definition
class ListUserProfilesResultTypeDef(TypedDict):
userProfiles: List[UserProfileSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CodeTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CodeTypeDef
def get_value() -> CodeTypeDef:
return {
"source": ...,
"destination": ...,
}
Definition
class CodeTypeDef(TypedDict):
source: CodeSourceTypeDef, # (1)
destination: CodeDestinationTypeDef, # (2)
ToolchainTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import ToolchainTypeDef
def get_value() -> ToolchainTypeDef:
return {
"source": ...,
}
Definition
class ToolchainTypeDef(TypedDict):
source: ToolchainSourceTypeDef, # (1)
roleArn: NotRequired[str],
stackParameters: NotRequired[Mapping[str, str]],
CreateProjectRequestRequestTypeDef
Usage Example
from mypy_boto3_codestar.type_defs import CreateProjectRequestRequestTypeDef
def get_value() -> CreateProjectRequestRequestTypeDef:
return {
"name": ...,
"id": ...,
}
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]],
- See CodeTypeDef
- See ToolchainTypeDef