Table of Contents
CodeStar.Client¶A low-level client representing AWS CodeStar:
client = session.create_client('codestar')
These are the available methods:
associate_team_member()can_paginate()create_project()create_user_profile()delete_project()delete_user_profile()describe_project()describe_user_profile()disassociate_team_member()generate_presigned_url()get_paginator()get_waiter()list_projects()list_resources()list_team_members()list_user_profiles()update_project()update_team_member()update_user_profile()associate_team_member(**kwargs)¶Adds an IAM user to the team for an AWS CodeStar project.
See also: AWS API Documentation
Request Syntax
response = client.associate_team_member(
projectId='string',
clientRequestToken='string',
userArn='string',
projectRole='string',
remoteAccessAllowed=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'clientRequestToken': 'string'
}
Response Structure
|
can_paginate(operation_name)¶Check if an operation can be paginated.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Returns: | True if the operation can be paginated,
False otherwise. |
create_project(**kwargs)¶Reserved for future use. To create a project, use the AWS CodeStar console.
See also: AWS API Documentation
Request Syntax
response = client.create_project(
name='string',
id='string',
description='string',
clientRequestToken='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'id': 'string',
'arn': 'string',
'clientRequestToken': 'string',
'projectTemplateId': 'string'
}
Response Structure
|
create_user_profile(**kwargs)¶Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user’s information appears to other users in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.create_user_profile(
userArn='string',
displayName='string',
emailAddress='string',
sshPublicKey='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
|
delete_project(**kwargs)¶Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.
See also: AWS API Documentation
Request Syntax
response = client.delete_project(
id='string',
clientRequestToken='string',
deleteStack=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'stackId': 'string',
'projectArn': 'string'
}
Response Structure
|
delete_user_profile(**kwargs)¶Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_profile(
userArn='string'
)
| Parameters: | userArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'userArn': 'string'
}
Response Structure
|
describe_project(**kwargs)¶Describes a project and its resources.
See also: AWS API Documentation
Request Syntax
response = client.describe_project(
id='string'
)
| Parameters: | id (string) – [REQUIRED] The ID of the project. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'name': 'string',
'id': 'string',
'arn': 'string',
'description': 'string',
'clientRequestToken': 'string',
'createdTimeStamp': datetime(2015, 1, 1),
'stackId': 'string',
'projectTemplateId': 'string'
}
Response Structure
|
describe_user_profile(**kwargs)¶Describes a user in AWS CodeStar and the user attributes across all projects.
See also: AWS API Documentation
Request Syntax
response = client.describe_user_profile(
userArn='string'
)
| Parameters: | userArn (string) – [REQUIRED] The Amazon Resource Name (ARN) of the user. |
|---|---|
| Return type: | dict |
| Returns: | Response Syntax{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
|
disassociate_team_member(**kwargs)¶Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user’s profile from AWS CodeStar. It does not remove the user from IAM.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_team_member(
projectId='string',
userArn='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)¶Generate a presigned url given a client, its method, and arguments
| Parameters: |
|
|---|---|
| Returns: | The presigned url |
get_paginator(operation_name)¶Create a paginator for an operation.
| Parameters: | operation_name (string) – The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you’d normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo"). |
|---|---|
| Raises: | OperationNotPageableError – Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable. |
| Return type: | L{botocore.paginate.Paginator} |
| Returns: | A paginator object. |
get_waiter(waiter_name)¶list_projects(**kwargs)¶Lists all projects in AWS CodeStar associated with your AWS account.
See also: AWS API Documentation
Request Syntax
response = client.list_projects(
nextToken='string',
maxResults=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'projects': [
{
'projectId': 'string',
'projectArn': 'string'
},
],
'nextToken': 'string'
}
Response Structure
|
list_resources(**kwargs)¶Lists resources associated with a project in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.list_resources(
projectId='string',
nextToken='string',
maxResults=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'resources': [
{
'id': 'string'
},
],
'nextToken': 'string'
}
Response Structure
|
list_team_members(**kwargs)¶Lists all team members associated with a project.
See also: AWS API Documentation
Request Syntax
response = client.list_team_members(
projectId='string',
nextToken='string',
maxResults=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'teamMembers': [
{
'userArn': 'string',
'projectRole': 'string',
'remoteAccessAllowed': True|False
},
],
'nextToken': 'string'
}
Response Structure
|
list_user_profiles(**kwargs)¶Lists all the user profiles configured for your AWS account in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.list_user_profiles(
nextToken='string',
maxResults=123
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'userProfiles': [
{
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string'
},
],
'nextToken': 'string'
}
Response Structure
|
update_project(**kwargs)¶Updates a project in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.update_project(
id='string',
name='string',
description='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {}
Response Structure
|
update_team_member(**kwargs)¶Updates a team member’s attributes in an AWS CodeStar project. For example, you can change a team member’s role in the project, or change whether they have remote access to project resources.
See also: AWS API Documentation
Request Syntax
response = client.update_team_member(
projectId='string',
userArn='string',
projectRole='string',
remoteAccessAllowed=True|False
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'userArn': 'string',
'projectRole': 'string',
'remoteAccessAllowed': True|False
}
Response Structure
|
update_user_profile(**kwargs)¶Updates a user’s profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user’s information appears to other users in AWS CodeStar.
See also: AWS API Documentation
Request Syntax
response = client.update_user_profile(
userArn='string',
displayName='string',
emailAddress='string',
sshPublicKey='string'
)
| Parameters: |
|
|---|---|
| Return type: | dict |
| Returns: | Response Syntax {
'userArn': 'string',
'displayName': 'string',
'emailAddress': 'string',
'sshPublicKey': 'string',
'createdTimestamp': datetime(2015, 1, 1),
'lastModifiedTimestamp': datetime(2015, 1, 1)
}
Response Structure
|
The available paginators are: