/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include
#include
#include
#include
#include
#include
namespace Aws
{
namespace CodeStar
{
/**
* AWS CodeStar This is the API reference for AWS CodeStar.
* This reference provides descriptions of the operations and data types for the
* AWS CodeStar API along with usage examples.
You can use the AWS CodeStar
* API to work with:
Projects and their resources, by calling the
* following:
-
DeleteProject
, which deletes a
* project.
-
DescribeProject
, which lists the
* attributes of a project.
-
ListProjects
, which
* lists all projects associated with your AWS account.
-
* ListResources
, which lists the resources associated with a
* project.
-
ListTagsForProject
, which lists the
* tags associated with a project.
-
TagProject
,
* which adds tags to a project.
-
UntagProject
,
* which removes tags from a project.
-
* UpdateProject
, which updates the attributes of a project.
*
Teams and team members, by calling the following:
-
* AssociateTeamMember
, which adds an IAM user to the team for a
* project.
-
DisassociateTeamMember
, which removes
* an IAM user from the team for a project.
-
* ListTeamMembers
, which lists all the IAM users in the team for a
* project, including their roles and attributes.
-
* UpdateTeamMember
, which updates a team member's attributes in a
* project.
Users, by calling the following:
-
* CreateUserProfile
, which creates a user profile that contains data
* associated with the user across all projects.
-
* DeleteUserProfile
, which deletes all user profile information
* across all projects.
-
DescribeUserProfile
, which
* describes the profile of a user.
-
* ListUserProfiles
, which lists all user profiles.
-
* UpdateUserProfile
, which updates the profile for a user.
*
*/
class AWS_CODESTAR_API CodeStarClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods
{
public:
typedef Aws::Client::AWSJsonClient BASECLASS;
static const char* SERVICE_NAME;
static const char* ALLOCATION_TAG;
typedef CodeStarClientConfiguration ClientConfigurationType;
typedef CodeStarEndpointProvider EndpointProviderType;
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeStarClient(const Aws::CodeStar::CodeStarClientConfiguration& clientConfiguration = Aws::CodeStar::CodeStarClientConfiguration(),
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG));
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeStarClient(const Aws::Auth::AWSCredentials& credentials,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::CodeStar::CodeStarClientConfiguration& clientConfiguration = Aws::CodeStar::CodeStarClientConfiguration());
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
CodeStarClient(const std::shared_ptr& credentialsProvider,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::CodeStar::CodeStarClientConfiguration& clientConfiguration = Aws::CodeStar::CodeStarClientConfiguration());
/* Legacy constructors due deprecation */
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeStarClient(const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
CodeStarClient(const Aws::Auth::AWSCredentials& credentials,
const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
CodeStarClient(const std::shared_ptr& credentialsProvider,
const Aws::Client::ClientConfiguration& clientConfiguration);
/* End of legacy constructors due deprecation */
virtual ~CodeStarClient();
/**
* Adds an IAM user to the team for an AWS CodeStar project.
See
* Also:
AWS
* API Reference
*/
virtual Model::AssociateTeamMemberOutcome AssociateTeamMember(const Model::AssociateTeamMemberRequest& request) const;
/**
* A Callable wrapper for AssociateTeamMember that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::AssociateTeamMemberOutcomeCallable AssociateTeamMemberCallable(const AssociateTeamMemberRequestT& request) const
{
return SubmitCallable(&CodeStarClient::AssociateTeamMember, request);
}
/**
* An Async wrapper for AssociateTeamMember that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void AssociateTeamMemberAsync(const AssociateTeamMemberRequestT& request, const AssociateTeamMemberResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::AssociateTeamMember, request, handler, context);
}
/**
* Creates a project, including project resources. This action creates a project
* based on a submitted project request. A set of source code files and a toolchain
* template file can be included with the project request. If these are not
* provided, an empty project is created.
See Also:
AWS
* API Reference
*/
virtual Model::CreateProjectOutcome CreateProject(const Model::CreateProjectRequest& request) const;
/**
* A Callable wrapper for CreateProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateProjectOutcomeCallable CreateProjectCallable(const CreateProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::CreateProject, request);
}
/**
* An Async wrapper for CreateProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateProjectAsync(const CreateProjectRequestT& request, const CreateProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::CreateProject, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::CreateUserProfileOutcome CreateUserProfile(const Model::CreateUserProfileRequest& request) const;
/**
* A Callable wrapper for CreateUserProfile that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateUserProfileOutcomeCallable CreateUserProfileCallable(const CreateUserProfileRequestT& request) const
{
return SubmitCallable(&CodeStarClient::CreateUserProfile, request);
}
/**
* An Async wrapper for CreateUserProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateUserProfileAsync(const CreateUserProfileRequestT& request, const CreateUserProfileResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::CreateUserProfile, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::DeleteProjectOutcome DeleteProject(const Model::DeleteProjectRequest& request) const;
/**
* A Callable wrapper for DeleteProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteProjectOutcomeCallable DeleteProjectCallable(const DeleteProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::DeleteProject, request);
}
/**
* An Async wrapper for DeleteProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteProjectAsync(const DeleteProjectRequestT& request, const DeleteProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::DeleteProject, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::DeleteUserProfileOutcome DeleteUserProfile(const Model::DeleteUserProfileRequest& request) const;
/**
* A Callable wrapper for DeleteUserProfile that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteUserProfileOutcomeCallable DeleteUserProfileCallable(const DeleteUserProfileRequestT& request) const
{
return SubmitCallable(&CodeStarClient::DeleteUserProfile, request);
}
/**
* An Async wrapper for DeleteUserProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteUserProfileAsync(const DeleteUserProfileRequestT& request, const DeleteUserProfileResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::DeleteUserProfile, request, handler, context);
}
/**
* Describes a project and its resources.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeProjectOutcome DescribeProject(const Model::DescribeProjectRequest& request) const;
/**
* A Callable wrapper for DescribeProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeProjectOutcomeCallable DescribeProjectCallable(const DescribeProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::DescribeProject, request);
}
/**
* An Async wrapper for DescribeProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeProjectAsync(const DescribeProjectRequestT& request, const DescribeProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::DescribeProject, request, handler, context);
}
/**
* Describes a user in AWS CodeStar and the user attributes across all
* projects.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeUserProfileOutcome DescribeUserProfile(const Model::DescribeUserProfileRequest& request) const;
/**
* A Callable wrapper for DescribeUserProfile that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeUserProfileOutcomeCallable DescribeUserProfileCallable(const DescribeUserProfileRequestT& request) const
{
return SubmitCallable(&CodeStarClient::DescribeUserProfile, request);
}
/**
* An Async wrapper for DescribeUserProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeUserProfileAsync(const DescribeUserProfileRequestT& request, const DescribeUserProfileResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::DescribeUserProfile, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::DisassociateTeamMemberOutcome DisassociateTeamMember(const Model::DisassociateTeamMemberRequest& request) const;
/**
* A Callable wrapper for DisassociateTeamMember that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DisassociateTeamMemberOutcomeCallable DisassociateTeamMemberCallable(const DisassociateTeamMemberRequestT& request) const
{
return SubmitCallable(&CodeStarClient::DisassociateTeamMember, request);
}
/**
* An Async wrapper for DisassociateTeamMember that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DisassociateTeamMemberAsync(const DisassociateTeamMemberRequestT& request, const DisassociateTeamMemberResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::DisassociateTeamMember, request, handler, context);
}
/**
* Lists all projects in AWS CodeStar associated with your AWS
* account.
See Also:
AWS
* API Reference
*/
virtual Model::ListProjectsOutcome ListProjects(const Model::ListProjectsRequest& request) const;
/**
* A Callable wrapper for ListProjects that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListProjectsOutcomeCallable ListProjectsCallable(const ListProjectsRequestT& request) const
{
return SubmitCallable(&CodeStarClient::ListProjects, request);
}
/**
* An Async wrapper for ListProjects that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListProjectsAsync(const ListProjectsRequestT& request, const ListProjectsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::ListProjects, request, handler, context);
}
/**
* Lists resources associated with a project in AWS CodeStar.
See
* Also:
AWS
* API Reference
*/
virtual Model::ListResourcesOutcome ListResources(const Model::ListResourcesRequest& request) const;
/**
* A Callable wrapper for ListResources that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListResourcesOutcomeCallable ListResourcesCallable(const ListResourcesRequestT& request) const
{
return SubmitCallable(&CodeStarClient::ListResources, request);
}
/**
* An Async wrapper for ListResources that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListResourcesAsync(const ListResourcesRequestT& request, const ListResourcesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::ListResources, request, handler, context);
}
/**
* Gets the tags for a project.
See Also:
AWS
* API Reference
*/
virtual Model::ListTagsForProjectOutcome ListTagsForProject(const Model::ListTagsForProjectRequest& request) const;
/**
* A Callable wrapper for ListTagsForProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListTagsForProjectOutcomeCallable ListTagsForProjectCallable(const ListTagsForProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::ListTagsForProject, request);
}
/**
* An Async wrapper for ListTagsForProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListTagsForProjectAsync(const ListTagsForProjectRequestT& request, const ListTagsForProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::ListTagsForProject, request, handler, context);
}
/**
* Lists all team members associated with a project.
See Also:
* AWS
* API Reference
*/
virtual Model::ListTeamMembersOutcome ListTeamMembers(const Model::ListTeamMembersRequest& request) const;
/**
* A Callable wrapper for ListTeamMembers that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListTeamMembersOutcomeCallable ListTeamMembersCallable(const ListTeamMembersRequestT& request) const
{
return SubmitCallable(&CodeStarClient::ListTeamMembers, request);
}
/**
* An Async wrapper for ListTeamMembers that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListTeamMembersAsync(const ListTeamMembersRequestT& request, const ListTeamMembersResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::ListTeamMembers, request, handler, context);
}
/**
* Lists all the user profiles configured for your AWS account in AWS
* CodeStar.
See Also:
AWS
* API Reference
*/
virtual Model::ListUserProfilesOutcome ListUserProfiles(const Model::ListUserProfilesRequest& request) const;
/**
* A Callable wrapper for ListUserProfiles that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListUserProfilesOutcomeCallable ListUserProfilesCallable(const ListUserProfilesRequestT& request) const
{
return SubmitCallable(&CodeStarClient::ListUserProfiles, request);
}
/**
* An Async wrapper for ListUserProfiles that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListUserProfilesAsync(const ListUserProfilesRequestT& request, const ListUserProfilesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::ListUserProfiles, request, handler, context);
}
/**
* Adds tags to a project.
See Also:
AWS
* API Reference
*/
virtual Model::TagProjectOutcome TagProject(const Model::TagProjectRequest& request) const;
/**
* A Callable wrapper for TagProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::TagProjectOutcomeCallable TagProjectCallable(const TagProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::TagProject, request);
}
/**
* An Async wrapper for TagProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void TagProjectAsync(const TagProjectRequestT& request, const TagProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::TagProject, request, handler, context);
}
/**
* Removes tags from a project.
See Also:
AWS
* API Reference
*/
virtual Model::UntagProjectOutcome UntagProject(const Model::UntagProjectRequest& request) const;
/**
* A Callable wrapper for UntagProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UntagProjectOutcomeCallable UntagProjectCallable(const UntagProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::UntagProject, request);
}
/**
* An Async wrapper for UntagProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UntagProjectAsync(const UntagProjectRequestT& request, const UntagProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::UntagProject, request, handler, context);
}
/**
* Updates a project in AWS CodeStar.
See Also:
AWS
* API Reference
*/
virtual Model::UpdateProjectOutcome UpdateProject(const Model::UpdateProjectRequest& request) const;
/**
* A Callable wrapper for UpdateProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UpdateProjectOutcomeCallable UpdateProjectCallable(const UpdateProjectRequestT& request) const
{
return SubmitCallable(&CodeStarClient::UpdateProject, request);
}
/**
* An Async wrapper for UpdateProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UpdateProjectAsync(const UpdateProjectRequestT& request, const UpdateProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::UpdateProject, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::UpdateTeamMemberOutcome UpdateTeamMember(const Model::UpdateTeamMemberRequest& request) const;
/**
* A Callable wrapper for UpdateTeamMember that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UpdateTeamMemberOutcomeCallable UpdateTeamMemberCallable(const UpdateTeamMemberRequestT& request) const
{
return SubmitCallable(&CodeStarClient::UpdateTeamMember, request);
}
/**
* An Async wrapper for UpdateTeamMember that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UpdateTeamMemberAsync(const UpdateTeamMemberRequestT& request, const UpdateTeamMemberResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::UpdateTeamMember, request, handler, context);
}
/**
* 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 Reference
*/
virtual Model::UpdateUserProfileOutcome UpdateUserProfile(const Model::UpdateUserProfileRequest& request) const;
/**
* A Callable wrapper for UpdateUserProfile that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UpdateUserProfileOutcomeCallable UpdateUserProfileCallable(const UpdateUserProfileRequestT& request) const
{
return SubmitCallable(&CodeStarClient::UpdateUserProfile, request);
}
/**
* An Async wrapper for UpdateUserProfile that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UpdateUserProfileAsync(const UpdateUserProfileRequestT& request, const UpdateUserProfileResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&CodeStarClient::UpdateUserProfile, request, handler, context);
}
void OverrideEndpoint(const Aws::String& endpoint);
std::shared_ptr& accessEndpointProvider();
private:
friend class Aws::Client::ClientWithAsyncTemplateMethods;
void init(const CodeStarClientConfiguration& clientConfiguration);
CodeStarClientConfiguration m_clientConfiguration;
std::shared_ptr m_executor;
std::shared_ptr m_endpointProvider;
};
} // namespace CodeStar
} // namespace Aws