Interface CodeCatalystAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
Welcome to the Amazon CodeCatalyst API reference. This reference provides descriptions of operations and data types for Amazon CodeCatalyst. You can use the Amazon CodeCatalyst API to work with the following objects.
Spaces, by calling the following:
-
DeleteSpace, which deletes a space.
-
GetSpace, which returns information about a space.
-
GetSubscription, which returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
-
ListSpaces, which retrieves a list of spaces.
-
UpdateSpace, which changes one or more values for a space.
Projects, by calling the following:
-
CreateProject which creates a project in a specified space.
-
GetProject, which returns information about a project.
-
ListProjects, which retrieves a list of projects in a space.
Users, by calling the following:
-
GetUserDetails, which returns information about a user in Amazon CodeCatalyst.
Source repositories, by calling the following:
-
CreateSourceRepository, which creates an empty Git-based source repository in a specified project.
-
CreateSourceRepositoryBranch, which creates a branch in a specified repository where you can work on code.
-
DeleteSourceRepository, which deletes a source repository.
-
GetSourceRepository, which returns information about a source repository.
-
GetSourceRepositoryCloneUrls, which returns information about the URLs that can be used with a Git client to clone a source repository.
-
ListSourceRepositories, which retrieves a list of source repositories in a project.
-
ListSourceRepositoryBranches, which retrieves a list of branches in a source repository.
Dev Environments and the Amazon Web Services Toolkits, by calling the following:
-
CreateDevEnvironment, which creates a Dev Environment, where you can quickly work on the code stored in the source repositories of your project.
-
DeleteDevEnvironment, which deletes a Dev Environment.
-
GetDevEnvironment, which returns information about a Dev Environment.
-
ListDevEnvironments, which retrieves a list of Dev Environments in a project.
-
ListDevEnvironmentSessions, which retrieves a list of active Dev Environment sessions in a project.
-
StartDevEnvironment, which starts a specified Dev Environment and puts it into an active state.
-
StartDevEnvironmentSession, which starts a session to a specified Dev Environment.
-
StopDevEnvironment, which stops a specified Dev Environment and puts it into an stopped state.
-
StopDevEnvironmentSession, which stops a session for a specified Dev Environment.
-
UpdateDevEnvironment, which changes one or more values for a Dev Environment.
Workflows, by calling the following:
-
GetWorkflow, which returns information about a workflow.
-
GetWorkflowRun, which returns information about a specified run of a workflow.
-
ListWorkflowRuns, which retrieves a list of runs of a specified workflow.
-
ListWorkflows, which retrieves a list of workflows in a specified project.
-
StartWorkflowRun, which starts a run of a specified workflow.
Security, activity, and resource management in Amazon CodeCatalyst, by calling the following:
-
CreateAccessToken, which creates a personal access token (PAT) for the current user.
-
DeleteAccessToken, which deletes a specified personal access token (PAT).
-
ListAccessTokens, which lists all personal access tokens (PATs) associated with a user.
-
ListEventLogs, which retrieves a list of events that occurred during a specified time period in a space.
-
VerifySession, which verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
If you are using the Amazon CodeCatalyst APIs with an SDK or the CLI, you must configure your computer to work with Amazon CodeCatalyst and single sign-on (SSO). For more information, see Setting up to use the CLI with Amazon CodeCatalyst and the SSO documentation for your SDK.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aCodeCatalystAsyncClient
.static CodeCatalystAsyncClient
create()
Create aCodeCatalystAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createAccessToken
(Consumer<CreateAccessTokenRequest.Builder> createAccessTokenRequest) Creates a personal access token (PAT) for the current user.createAccessToken
(CreateAccessTokenRequest createAccessTokenRequest) Creates a personal access token (PAT) for the current user.createDevEnvironment
(Consumer<CreateDevEnvironmentRequest.Builder> createDevEnvironmentRequest) Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.createDevEnvironment
(CreateDevEnvironmentRequest createDevEnvironmentRequest) Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.default CompletableFuture
<CreateProjectResponse> createProject
(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates a project in a specified space.default CompletableFuture
<CreateProjectResponse> createProject
(CreateProjectRequest createProjectRequest) Creates a project in a specified space.createSourceRepository
(Consumer<CreateSourceRepositoryRequest.Builder> createSourceRepositoryRequest) Creates an empty Git-based source repository in a specified project.createSourceRepository
(CreateSourceRepositoryRequest createSourceRepositoryRequest) Creates an empty Git-based source repository in a specified project.createSourceRepositoryBranch
(Consumer<CreateSourceRepositoryBranchRequest.Builder> createSourceRepositoryBranchRequest) Creates a branch in a specified source repository in Amazon CodeCatalyst.createSourceRepositoryBranch
(CreateSourceRepositoryBranchRequest createSourceRepositoryBranchRequest) Creates a branch in a specified source repository in Amazon CodeCatalyst.deleteAccessToken
(Consumer<DeleteAccessTokenRequest.Builder> deleteAccessTokenRequest) Deletes a specified personal access token (PAT).deleteAccessToken
(DeleteAccessTokenRequest deleteAccessTokenRequest) Deletes a specified personal access token (PAT).deleteDevEnvironment
(Consumer<DeleteDevEnvironmentRequest.Builder> deleteDevEnvironmentRequest) Deletes a Dev Environment.deleteDevEnvironment
(DeleteDevEnvironmentRequest deleteDevEnvironmentRequest) Deletes a Dev Environment.default CompletableFuture
<DeleteProjectResponse> deleteProject
(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a project in a space.default CompletableFuture
<DeleteProjectResponse> deleteProject
(DeleteProjectRequest deleteProjectRequest) Deletes a project in a space.deleteSourceRepository
(Consumer<DeleteSourceRepositoryRequest.Builder> deleteSourceRepositoryRequest) Deletes a source repository in Amazon CodeCatalyst.deleteSourceRepository
(DeleteSourceRepositoryRequest deleteSourceRepositoryRequest) Deletes a source repository in Amazon CodeCatalyst.default CompletableFuture
<DeleteSpaceResponse> deleteSpace
(Consumer<DeleteSpaceRequest.Builder> deleteSpaceRequest) Deletes a space.default CompletableFuture
<DeleteSpaceResponse> deleteSpace
(DeleteSpaceRequest deleteSpaceRequest) Deletes a space.getDevEnvironment
(Consumer<GetDevEnvironmentRequest.Builder> getDevEnvironmentRequest) Returns information about a Dev Environment for a source repository in a project.getDevEnvironment
(GetDevEnvironmentRequest getDevEnvironmentRequest) Returns information about a Dev Environment for a source repository in a project.default CompletableFuture
<GetProjectResponse> getProject
(Consumer<GetProjectRequest.Builder> getProjectRequest) Returns information about a project.default CompletableFuture
<GetProjectResponse> getProject
(GetProjectRequest getProjectRequest) Returns information about a project.getSourceRepository
(Consumer<GetSourceRepositoryRequest.Builder> getSourceRepositoryRequest) Returns information about a source repository.getSourceRepository
(GetSourceRepositoryRequest getSourceRepositoryRequest) Returns information about a source repository.getSourceRepositoryCloneUrls
(Consumer<GetSourceRepositoryCloneUrlsRequest.Builder> getSourceRepositoryCloneUrlsRequest) Returns information about the URLs that can be used with a Git client to clone a source repository.getSourceRepositoryCloneUrls
(GetSourceRepositoryCloneUrlsRequest getSourceRepositoryCloneUrlsRequest) Returns information about the URLs that can be used with a Git client to clone a source repository.default CompletableFuture
<GetSpaceResponse> getSpace
(Consumer<GetSpaceRequest.Builder> getSpaceRequest) Returns information about an space.default CompletableFuture
<GetSpaceResponse> getSpace
(GetSpaceRequest getSpaceRequest) Returns information about an space.default CompletableFuture
<GetSubscriptionResponse> getSubscription
(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest) Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.default CompletableFuture
<GetSubscriptionResponse> getSubscription
(GetSubscriptionRequest getSubscriptionRequest) Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.default CompletableFuture
<GetUserDetailsResponse> getUserDetails
(Consumer<GetUserDetailsRequest.Builder> getUserDetailsRequest) Returns information about a user.default CompletableFuture
<GetUserDetailsResponse> getUserDetails
(GetUserDetailsRequest getUserDetailsRequest) Returns information about a user.default CompletableFuture
<GetWorkflowResponse> getWorkflow
(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) Returns information about a workflow.default CompletableFuture
<GetWorkflowResponse> getWorkflow
(GetWorkflowRequest getWorkflowRequest) Returns information about a workflow.default CompletableFuture
<GetWorkflowRunResponse> getWorkflowRun
(Consumer<GetWorkflowRunRequest.Builder> getWorkflowRunRequest) Returns information about a specified run of a workflow.default CompletableFuture
<GetWorkflowRunResponse> getWorkflowRun
(GetWorkflowRunRequest getWorkflowRunRequest) Returns information about a specified run of a workflow.listAccessTokens
(Consumer<ListAccessTokensRequest.Builder> listAccessTokensRequest) Lists all personal access tokens (PATs) associated with the user who calls the API.listAccessTokens
(ListAccessTokensRequest listAccessTokensRequest) Lists all personal access tokens (PATs) associated with the user who calls the API.default ListAccessTokensPublisher
listAccessTokensPaginator
(Consumer<ListAccessTokensRequest.Builder> listAccessTokensRequest) This is a variant oflistAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation.default ListAccessTokensPublisher
listAccessTokensPaginator
(ListAccessTokensRequest listAccessTokensRequest) This is a variant oflistAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation.listDevEnvironments
(Consumer<ListDevEnvironmentsRequest.Builder> listDevEnvironmentsRequest) Retrieves a list of Dev Environments in a project.listDevEnvironments
(ListDevEnvironmentsRequest listDevEnvironmentsRequest) Retrieves a list of Dev Environments in a project.listDevEnvironmentSessions
(Consumer<ListDevEnvironmentSessionsRequest.Builder> listDevEnvironmentSessionsRequest) Retrieves a list of active sessions for a Dev Environment in a project.listDevEnvironmentSessions
(ListDevEnvironmentSessionsRequest listDevEnvironmentSessionsRequest) Retrieves a list of active sessions for a Dev Environment in a project.listDevEnvironmentSessionsPaginator
(Consumer<ListDevEnvironmentSessionsRequest.Builder> listDevEnvironmentSessionsRequest) This is a variant oflistDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation.listDevEnvironmentSessionsPaginator
(ListDevEnvironmentSessionsRequest listDevEnvironmentSessionsRequest) This is a variant oflistDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation.default ListDevEnvironmentsPublisher
listDevEnvironmentsPaginator
(Consumer<ListDevEnvironmentsRequest.Builder> listDevEnvironmentsRequest) This is a variant oflistDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation.default ListDevEnvironmentsPublisher
listDevEnvironmentsPaginator
(ListDevEnvironmentsRequest listDevEnvironmentsRequest) This is a variant oflistDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation.default CompletableFuture
<ListEventLogsResponse> listEventLogs
(Consumer<ListEventLogsRequest.Builder> listEventLogsRequest) Retrieves a list of events that occurred during a specific time in a space.default CompletableFuture
<ListEventLogsResponse> listEventLogs
(ListEventLogsRequest listEventLogsRequest) Retrieves a list of events that occurred during a specific time in a space.default ListEventLogsPublisher
listEventLogsPaginator
(Consumer<ListEventLogsRequest.Builder> listEventLogsRequest) This is a variant oflistEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation.default ListEventLogsPublisher
listEventLogsPaginator
(ListEventLogsRequest listEventLogsRequest) This is a variant oflistEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation.default CompletableFuture
<ListProjectsResponse> listProjects
(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Retrieves a list of projects.default CompletableFuture
<ListProjectsResponse> listProjects
(ListProjectsRequest listProjectsRequest) Retrieves a list of projects.default ListProjectsPublisher
listProjectsPaginator
(Consumer<ListProjectsRequest.Builder> listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation.default ListProjectsPublisher
listProjectsPaginator
(ListProjectsRequest listProjectsRequest) This is a variant oflistProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation.listSourceRepositories
(Consumer<ListSourceRepositoriesRequest.Builder> listSourceRepositoriesRequest) Retrieves a list of source repositories in a project.listSourceRepositories
(ListSourceRepositoriesRequest listSourceRepositoriesRequest) Retrieves a list of source repositories in a project.default ListSourceRepositoriesPublisher
listSourceRepositoriesPaginator
(Consumer<ListSourceRepositoriesRequest.Builder> listSourceRepositoriesRequest) This is a variant oflistSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation.default ListSourceRepositoriesPublisher
listSourceRepositoriesPaginator
(ListSourceRepositoriesRequest listSourceRepositoriesRequest) This is a variant oflistSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation.listSourceRepositoryBranches
(Consumer<ListSourceRepositoryBranchesRequest.Builder> listSourceRepositoryBranchesRequest) Retrieves a list of branches in a specified source repository.listSourceRepositoryBranches
(ListSourceRepositoryBranchesRequest listSourceRepositoryBranchesRequest) Retrieves a list of branches in a specified source repository.listSourceRepositoryBranchesPaginator
(Consumer<ListSourceRepositoryBranchesRequest.Builder> listSourceRepositoryBranchesRequest) This is a variant oflistSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation.listSourceRepositoryBranchesPaginator
(ListSourceRepositoryBranchesRequest listSourceRepositoryBranchesRequest) This is a variant oflistSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation.default CompletableFuture
<ListSpacesResponse> listSpaces
(Consumer<ListSpacesRequest.Builder> listSpacesRequest) Retrieves a list of spaces.default CompletableFuture
<ListSpacesResponse> listSpaces
(ListSpacesRequest listSpacesRequest) Retrieves a list of spaces.default ListSpacesPublisher
listSpacesPaginator
(Consumer<ListSpacesRequest.Builder> listSpacesRequest) This is a variant oflistSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation.default ListSpacesPublisher
listSpacesPaginator
(ListSpacesRequest listSpacesRequest) This is a variant oflistSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation.listWorkflowRuns
(Consumer<ListWorkflowRunsRequest.Builder> listWorkflowRunsRequest) Retrieves a list of workflow runs of a specified workflow.listWorkflowRuns
(ListWorkflowRunsRequest listWorkflowRunsRequest) Retrieves a list of workflow runs of a specified workflow.default ListWorkflowRunsPublisher
listWorkflowRunsPaginator
(Consumer<ListWorkflowRunsRequest.Builder> listWorkflowRunsRequest) This is a variant oflistWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation.default ListWorkflowRunsPublisher
listWorkflowRunsPaginator
(ListWorkflowRunsRequest listWorkflowRunsRequest) This is a variant oflistWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation.default CompletableFuture
<ListWorkflowsResponse> listWorkflows
(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Retrieves a list of workflows in a specified project.default CompletableFuture
<ListWorkflowsResponse> listWorkflows
(ListWorkflowsRequest listWorkflowsRequest) Retrieves a list of workflows in a specified project.default ListWorkflowsPublisher
listWorkflowsPaginator
(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation.default ListWorkflowsPublisher
listWorkflowsPaginator
(ListWorkflowsRequest listWorkflowsRequest) This is a variant oflistWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartDevEnvironment
(Consumer<StartDevEnvironmentRequest.Builder> startDevEnvironmentRequest) Starts a specified Dev Environment and puts it into an active state.startDevEnvironment
(StartDevEnvironmentRequest startDevEnvironmentRequest) Starts a specified Dev Environment and puts it into an active state.startDevEnvironmentSession
(Consumer<StartDevEnvironmentSessionRequest.Builder> startDevEnvironmentSessionRequest) Starts a session for a specified Dev Environment.startDevEnvironmentSession
(StartDevEnvironmentSessionRequest startDevEnvironmentSessionRequest) Starts a session for a specified Dev Environment.startWorkflowRun
(Consumer<StartWorkflowRunRequest.Builder> startWorkflowRunRequest) Begins a run of a specified workflow.startWorkflowRun
(StartWorkflowRunRequest startWorkflowRunRequest) Begins a run of a specified workflow.stopDevEnvironment
(Consumer<StopDevEnvironmentRequest.Builder> stopDevEnvironmentRequest) Pauses a specified Dev Environment and places it in a non-running state.stopDevEnvironment
(StopDevEnvironmentRequest stopDevEnvironmentRequest) Pauses a specified Dev Environment and places it in a non-running state.stopDevEnvironmentSession
(Consumer<StopDevEnvironmentSessionRequest.Builder> stopDevEnvironmentSessionRequest) Stops a session for a specified Dev Environment.stopDevEnvironmentSession
(StopDevEnvironmentSessionRequest stopDevEnvironmentSessionRequest) Stops a session for a specified Dev Environment.updateDevEnvironment
(Consumer<UpdateDevEnvironmentRequest.Builder> updateDevEnvironmentRequest) Changes one or more values for a Dev Environment.updateDevEnvironment
(UpdateDevEnvironmentRequest updateDevEnvironmentRequest) Changes one or more values for a Dev Environment.default CompletableFuture
<UpdateProjectResponse> updateProject
(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Changes one or more values for a project.default CompletableFuture
<UpdateProjectResponse> updateProject
(UpdateProjectRequest updateProjectRequest) Changes one or more values for a project.default CompletableFuture
<UpdateSpaceResponse> updateSpace
(Consumer<UpdateSpaceRequest.Builder> updateSpaceRequest) Changes one or more values for a space.default CompletableFuture
<UpdateSpaceResponse> updateSpace
(UpdateSpaceRequest updateSpaceRequest) Changes one or more values for a space.default CompletableFuture
<VerifySessionResponse> verifySession
(Consumer<VerifySessionRequest.Builder> verifySessionRequest) Verifies whether the calling user has a valid Amazon CodeCatalyst login and session.default CompletableFuture
<VerifySessionResponse> verifySession
(VerifySessionRequest verifySessionRequest) Verifies whether the calling user has a valid Amazon CodeCatalyst login and session.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createAccessToken
default CompletableFuture<CreateAccessTokenResponse> createAccessToken(CreateAccessTokenRequest createAccessTokenRequest) Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.
- Parameters:
createAccessTokenRequest
-- Returns:
- A Java Future containing the result of the CreateAccessToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessToken
default CompletableFuture<CreateAccessTokenResponse> createAccessToken(Consumer<CreateAccessTokenRequest.Builder> createAccessTokenRequest) Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.
This is a convenience which creates an instance of the
CreateAccessTokenRequest.Builder
avoiding the need to create one manually viaCreateAccessTokenRequest.builder()
- Parameters:
createAccessTokenRequest
- AConsumer
that will call methods onCreateAccessTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateAccessToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDevEnvironment
default CompletableFuture<CreateDevEnvironmentResponse> createDevEnvironment(CreateDevEnvironmentRequest createDevEnvironmentRequest) Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.
- Parameters:
createDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the CreateDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDevEnvironment
default CompletableFuture<CreateDevEnvironmentResponse> createDevEnvironment(Consumer<CreateDevEnvironmentRequest.Builder> createDevEnvironmentRequest) Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
When created in the Amazon CodeCatalyst console, by default a Dev Environment is configured to have a 2 core processor, 4GB of RAM, and 16GB of persistent storage. None of these defaults apply to a Dev Environment created programmatically.
This is a convenience which creates an instance of the
CreateDevEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateDevEnvironmentRequest.builder()
- Parameters:
createDevEnvironmentRequest
- AConsumer
that will call methods onCreateDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProject
default CompletableFuture<CreateProjectResponse> createProject(CreateProjectRequest createProjectRequest) Creates a project in a specified space.
- Parameters:
createProjectRequest
-- Returns:
- A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createProject
default CompletableFuture<CreateProjectResponse> createProject(Consumer<CreateProjectRequest.Builder> createProjectRequest) Creates a project in a specified space.
This is a convenience which creates an instance of the
CreateProjectRequest.Builder
avoiding the need to create one manually viaCreateProjectRequest.builder()
- Parameters:
createProjectRequest
- AConsumer
that will call methods onCreateProjectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSourceRepository
default CompletableFuture<CreateSourceRepositoryResponse> createSourceRepository(CreateSourceRepositoryRequest createSourceRepositoryRequest) Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named
main
.- Parameters:
createSourceRepositoryRequest
-- Returns:
- A Java Future containing the result of the CreateSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSourceRepository
default CompletableFuture<CreateSourceRepositoryResponse> createSourceRepository(Consumer<CreateSourceRepositoryRequest.Builder> createSourceRepositoryRequest) Creates an empty Git-based source repository in a specified project. The repository is created with an initial empty commit with a default branch named
main
.
This is a convenience which creates an instance of the
CreateSourceRepositoryRequest.Builder
avoiding the need to create one manually viaCreateSourceRepositoryRequest.builder()
- Parameters:
createSourceRepositoryRequest
- AConsumer
that will call methods onCreateSourceRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSourceRepositoryBranch
default CompletableFuture<CreateSourceRepositoryBranchResponse> createSourceRepositoryBranch(CreateSourceRepositoryBranchRequest createSourceRepositoryBranchRequest) Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.
- Parameters:
createSourceRepositoryBranchRequest
-- Returns:
- A Java Future containing the result of the CreateSourceRepositoryBranch operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSourceRepositoryBranch
default CompletableFuture<CreateSourceRepositoryBranchResponse> createSourceRepositoryBranch(Consumer<CreateSourceRepositoryBranchRequest.Builder> createSourceRepositoryBranchRequest) Creates a branch in a specified source repository in Amazon CodeCatalyst.
This API only creates a branch in a source repository hosted in Amazon CodeCatalyst. You cannot use this API to create a branch in a linked repository.
This is a convenience which creates an instance of the
CreateSourceRepositoryBranchRequest.Builder
avoiding the need to create one manually viaCreateSourceRepositoryBranchRequest.builder()
- Parameters:
createSourceRepositoryBranchRequest
- AConsumer
that will call methods onCreateSourceRepositoryBranchRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSourceRepositoryBranch operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessToken
default CompletableFuture<DeleteAccessTokenResponse> deleteAccessToken(DeleteAccessTokenRequest deleteAccessTokenRequest) Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.
- Parameters:
deleteAccessTokenRequest
-- Returns:
- A Java Future containing the result of the DeleteAccessToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessToken
default CompletableFuture<DeleteAccessTokenResponse> deleteAccessToken(Consumer<DeleteAccessTokenRequest.Builder> deleteAccessTokenRequest) Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.
This is a convenience which creates an instance of the
DeleteAccessTokenRequest.Builder
avoiding the need to create one manually viaDeleteAccessTokenRequest.builder()
- Parameters:
deleteAccessTokenRequest
- AConsumer
that will call methods onDeleteAccessTokenRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAccessToken operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevEnvironment
default CompletableFuture<DeleteDevEnvironmentResponse> deleteDevEnvironment(DeleteDevEnvironmentRequest deleteDevEnvironmentRequest) Deletes a Dev Environment.
- Parameters:
deleteDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDevEnvironment
default CompletableFuture<DeleteDevEnvironmentResponse> deleteDevEnvironment(Consumer<DeleteDevEnvironmentRequest.Builder> deleteDevEnvironmentRequest) Deletes a Dev Environment.
This is a convenience which creates an instance of the
DeleteDevEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteDevEnvironmentRequest.builder()
- Parameters:
deleteDevEnvironmentRequest
- AConsumer
that will call methods onDeleteDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProject
default CompletableFuture<DeleteProjectResponse> deleteProject(DeleteProjectRequest deleteProjectRequest) Deletes a project in a space.
- Parameters:
deleteProjectRequest
-- Returns:
- A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteProject
default CompletableFuture<DeleteProjectResponse> deleteProject(Consumer<DeleteProjectRequest.Builder> deleteProjectRequest) Deletes a project in a space.
This is a convenience which creates an instance of the
DeleteProjectRequest.Builder
avoiding the need to create one manually viaDeleteProjectRequest.builder()
- Parameters:
deleteProjectRequest
- AConsumer
that will call methods onDeleteProjectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSourceRepository
default CompletableFuture<DeleteSourceRepositoryResponse> deleteSourceRepository(DeleteSourceRepositoryRequest deleteSourceRepositoryRequest) Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.
- Parameters:
deleteSourceRepositoryRequest
-- Returns:
- A Java Future containing the result of the DeleteSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSourceRepository
default CompletableFuture<DeleteSourceRepositoryResponse> deleteSourceRepository(Consumer<DeleteSourceRepositoryRequest.Builder> deleteSourceRepositoryRequest) Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.
This is a convenience which creates an instance of the
DeleteSourceRepositoryRequest.Builder
avoiding the need to create one manually viaDeleteSourceRepositoryRequest.builder()
- Parameters:
deleteSourceRepositoryRequest
- AConsumer
that will call methods onDeleteSourceRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSpace
Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
- Parameters:
deleteSpaceRequest
-- Returns:
- A Java Future containing the result of the DeleteSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSpace
default CompletableFuture<DeleteSpaceResponse> deleteSpace(Consumer<DeleteSpaceRequest.Builder> deleteSpaceRequest) Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
This is a convenience which creates an instance of the
DeleteSpaceRequest.Builder
avoiding the need to create one manually viaDeleteSpaceRequest.builder()
- Parameters:
deleteSpaceRequest
- AConsumer
that will call methods onDeleteSpaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevEnvironment
default CompletableFuture<GetDevEnvironmentResponse> getDevEnvironment(GetDevEnvironmentRequest getDevEnvironmentRequest) Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
- Parameters:
getDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the GetDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDevEnvironment
default CompletableFuture<GetDevEnvironmentResponse> getDevEnvironment(Consumer<GetDevEnvironmentRequest.Builder> getDevEnvironmentRequest) Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
This is a convenience which creates an instance of the
GetDevEnvironmentRequest.Builder
avoiding the need to create one manually viaGetDevEnvironmentRequest.builder()
- Parameters:
getDevEnvironmentRequest
- AConsumer
that will call methods onGetDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProject
Returns information about a project.
- Parameters:
getProjectRequest
-- Returns:
- A Java Future containing the result of the GetProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProject
default CompletableFuture<GetProjectResponse> getProject(Consumer<GetProjectRequest.Builder> getProjectRequest) Returns information about a project.
This is a convenience which creates an instance of the
GetProjectRequest.Builder
avoiding the need to create one manually viaGetProjectRequest.builder()
- Parameters:
getProjectRequest
- AConsumer
that will call methods onGetProjectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSourceRepository
default CompletableFuture<GetSourceRepositoryResponse> getSourceRepository(GetSourceRepositoryRequest getSourceRepositoryRequest) Returns information about a source repository.
- Parameters:
getSourceRepositoryRequest
-- Returns:
- A Java Future containing the result of the GetSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSourceRepository
default CompletableFuture<GetSourceRepositoryResponse> getSourceRepository(Consumer<GetSourceRepositoryRequest.Builder> getSourceRepositoryRequest) Returns information about a source repository.
This is a convenience which creates an instance of the
GetSourceRepositoryRequest.Builder
avoiding the need to create one manually viaGetSourceRepositoryRequest.builder()
- Parameters:
getSourceRepositoryRequest
- AConsumer
that will call methods onGetSourceRepositoryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSourceRepository operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSourceRepositoryCloneUrls
default CompletableFuture<GetSourceRepositoryCloneUrlsResponse> getSourceRepositoryCloneUrls(GetSourceRepositoryCloneUrlsRequest getSourceRepositoryCloneUrlsRequest) Returns information about the URLs that can be used with a Git client to clone a source repository.
- Parameters:
getSourceRepositoryCloneUrlsRequest
-- Returns:
- A Java Future containing the result of the GetSourceRepositoryCloneUrls operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSourceRepositoryCloneUrls
default CompletableFuture<GetSourceRepositoryCloneUrlsResponse> getSourceRepositoryCloneUrls(Consumer<GetSourceRepositoryCloneUrlsRequest.Builder> getSourceRepositoryCloneUrlsRequest) Returns information about the URLs that can be used with a Git client to clone a source repository.
This is a convenience which creates an instance of the
GetSourceRepositoryCloneUrlsRequest.Builder
avoiding the need to create one manually viaGetSourceRepositoryCloneUrlsRequest.builder()
- Parameters:
getSourceRepositoryCloneUrlsRequest
- AConsumer
that will call methods onGetSourceRepositoryCloneUrlsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSourceRepositoryCloneUrls operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpace
Returns information about an space.
- Parameters:
getSpaceRequest
-- Returns:
- A Java Future containing the result of the GetSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpace
default CompletableFuture<GetSpaceResponse> getSpace(Consumer<GetSpaceRequest.Builder> getSpaceRequest) Returns information about an space.
This is a convenience which creates an instance of the
GetSpaceRequest.Builder
avoiding the need to create one manually viaGetSpaceRequest.builder()
- Parameters:
getSpaceRequest
- AConsumer
that will call methods onGetSpaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubscription
default CompletableFuture<GetSubscriptionResponse> getSubscription(GetSubscriptionRequest getSubscriptionRequest) Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
- Parameters:
getSubscriptionRequest
-- Returns:
- A Java Future containing the result of the GetSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSubscription
default CompletableFuture<GetSubscriptionResponse> getSubscription(Consumer<GetSubscriptionRequest.Builder> getSubscriptionRequest) Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
This is a convenience which creates an instance of the
GetSubscriptionRequest.Builder
avoiding the need to create one manually viaGetSubscriptionRequest.builder()
- Parameters:
getSubscriptionRequest
- AConsumer
that will call methods onGetSubscriptionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSubscription operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUserDetails
default CompletableFuture<GetUserDetailsResponse> getUserDetails(GetUserDetailsRequest getUserDetailsRequest) Returns information about a user.
- Parameters:
getUserDetailsRequest
-- Returns:
- A Java Future containing the result of the GetUserDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUserDetails
default CompletableFuture<GetUserDetailsResponse> getUserDetails(Consumer<GetUserDetailsRequest.Builder> getUserDetailsRequest) Returns information about a user.
This is a convenience which creates an instance of the
GetUserDetailsRequest.Builder
avoiding the need to create one manually viaGetUserDetailsRequest.builder()
- Parameters:
getUserDetailsRequest
- AConsumer
that will call methods onGetUserDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetUserDetails operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflow
Returns information about a workflow.
- Parameters:
getWorkflowRequest
-- Returns:
- A Java Future containing the result of the GetWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflow
default CompletableFuture<GetWorkflowResponse> getWorkflow(Consumer<GetWorkflowRequest.Builder> getWorkflowRequest) Returns information about a workflow.
This is a convenience which creates an instance of the
GetWorkflowRequest.Builder
avoiding the need to create one manually viaGetWorkflowRequest.builder()
- Parameters:
getWorkflowRequest
- AConsumer
that will call methods onGetWorkflowRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetWorkflow operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflowRun
default CompletableFuture<GetWorkflowRunResponse> getWorkflowRun(GetWorkflowRunRequest getWorkflowRunRequest) Returns information about a specified run of a workflow.
- Parameters:
getWorkflowRunRequest
-- Returns:
- A Java Future containing the result of the GetWorkflowRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkflowRun
default CompletableFuture<GetWorkflowRunResponse> getWorkflowRun(Consumer<GetWorkflowRunRequest.Builder> getWorkflowRunRequest) Returns information about a specified run of a workflow.
This is a convenience which creates an instance of the
GetWorkflowRunRequest.Builder
avoiding the need to create one manually viaGetWorkflowRunRequest.builder()
- Parameters:
getWorkflowRunRequest
- AConsumer
that will call methods onGetWorkflowRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetWorkflowRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessTokens
default CompletableFuture<ListAccessTokensResponse> listAccessTokens(ListAccessTokensRequest listAccessTokensRequest) Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.
- Parameters:
listAccessTokensRequest
-- Returns:
- A Java Future containing the result of the ListAccessTokens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessTokens
default CompletableFuture<ListAccessTokensResponse> listAccessTokens(Consumer<ListAccessTokensRequest.Builder> listAccessTokensRequest) Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.
This is a convenience which creates an instance of the
ListAccessTokensRequest.Builder
avoiding the need to create one manually viaListAccessTokensRequest.builder()
- Parameters:
listAccessTokensRequest
- AConsumer
that will call methods onListAccessTokensRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAccessTokens operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessTokensPaginator
default ListAccessTokensPublisher listAccessTokensPaginator(ListAccessTokensRequest listAccessTokensRequest) This is a variant of
listAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListAccessTokensPublisher publisher = client.listAccessTokensPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListAccessTokensPublisher publisher = client.listAccessTokensPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation.- Parameters:
listAccessTokensRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessTokensPaginator
default ListAccessTokensPublisher listAccessTokensPaginator(Consumer<ListAccessTokensRequest.Builder> listAccessTokensRequest) This is a variant of
listAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListAccessTokensPublisher publisher = client.listAccessTokensPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListAccessTokensPublisher publisher = client.listAccessTokensPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAccessTokens(software.amazon.awssdk.services.codecatalyst.model.ListAccessTokensRequest)
operation.
This is a convenience which creates an instance of the
ListAccessTokensRequest.Builder
avoiding the need to create one manually viaListAccessTokensRequest.builder()
- Parameters:
listAccessTokensRequest
- AConsumer
that will call methods onListAccessTokensRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentSessions
default CompletableFuture<ListDevEnvironmentSessionsResponse> listDevEnvironmentSessions(ListDevEnvironmentSessionsRequest listDevEnvironmentSessionsRequest) Retrieves a list of active sessions for a Dev Environment in a project.
- Parameters:
listDevEnvironmentSessionsRequest
-- Returns:
- A Java Future containing the result of the ListDevEnvironmentSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentSessions
default CompletableFuture<ListDevEnvironmentSessionsResponse> listDevEnvironmentSessions(Consumer<ListDevEnvironmentSessionsRequest.Builder> listDevEnvironmentSessionsRequest) Retrieves a list of active sessions for a Dev Environment in a project.
This is a convenience which creates an instance of the
ListDevEnvironmentSessionsRequest.Builder
avoiding the need to create one manually viaListDevEnvironmentSessionsRequest.builder()
- Parameters:
listDevEnvironmentSessionsRequest
- AConsumer
that will call methods onListDevEnvironmentSessionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDevEnvironmentSessions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentSessionsPaginator
default ListDevEnvironmentSessionsPublisher listDevEnvironmentSessionsPaginator(ListDevEnvironmentSessionsRequest listDevEnvironmentSessionsRequest) This is a variant of
listDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentSessionsPublisher publisher = client.listDevEnvironmentSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentSessionsPublisher publisher = client.listDevEnvironmentSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation.- Parameters:
listDevEnvironmentSessionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentSessionsPaginator
default ListDevEnvironmentSessionsPublisher listDevEnvironmentSessionsPaginator(Consumer<ListDevEnvironmentSessionsRequest.Builder> listDevEnvironmentSessionsRequest) This is a variant of
listDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentSessionsPublisher publisher = client.listDevEnvironmentSessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentSessionsPublisher publisher = client.listDevEnvironmentSessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevEnvironmentSessions(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentSessionsRequest)
operation.
This is a convenience which creates an instance of the
ListDevEnvironmentSessionsRequest.Builder
avoiding the need to create one manually viaListDevEnvironmentSessionsRequest.builder()
- Parameters:
listDevEnvironmentSessionsRequest
- AConsumer
that will call methods onListDevEnvironmentSessionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironments
default CompletableFuture<ListDevEnvironmentsResponse> listDevEnvironments(ListDevEnvironmentsRequest listDevEnvironmentsRequest) Retrieves a list of Dev Environments in a project.
- Parameters:
listDevEnvironmentsRequest
-- Returns:
- A Java Future containing the result of the ListDevEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironments
default CompletableFuture<ListDevEnvironmentsResponse> listDevEnvironments(Consumer<ListDevEnvironmentsRequest.Builder> listDevEnvironmentsRequest) Retrieves a list of Dev Environments in a project.
This is a convenience which creates an instance of the
ListDevEnvironmentsRequest.Builder
avoiding the need to create one manually viaListDevEnvironmentsRequest.builder()
- Parameters:
listDevEnvironmentsRequest
- AConsumer
that will call methods onListDevEnvironmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDevEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentsPaginator
default ListDevEnvironmentsPublisher listDevEnvironmentsPaginator(ListDevEnvironmentsRequest listDevEnvironmentsRequest) This is a variant of
listDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentsPublisher publisher = client.listDevEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentsPublisher publisher = client.listDevEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation.- Parameters:
listDevEnvironmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDevEnvironmentsPaginator
default ListDevEnvironmentsPublisher listDevEnvironmentsPaginator(Consumer<ListDevEnvironmentsRequest.Builder> listDevEnvironmentsRequest) This is a variant of
listDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentsPublisher publisher = client.listDevEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListDevEnvironmentsPublisher publisher = client.listDevEnvironmentsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevEnvironments(software.amazon.awssdk.services.codecatalyst.model.ListDevEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the
ListDevEnvironmentsRequest.Builder
avoiding the need to create one manually viaListDevEnvironmentsRequest.builder()
- Parameters:
listDevEnvironmentsRequest
- AConsumer
that will call methods onListDevEnvironmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventLogs
default CompletableFuture<ListEventLogsResponse> listEventLogs(ListEventLogsRequest listEventLogsRequest) Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.
ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.
- Parameters:
listEventLogsRequest
-- Returns:
- A Java Future containing the result of the ListEventLogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventLogs
default CompletableFuture<ListEventLogsResponse> listEventLogs(Consumer<ListEventLogsRequest.Builder> listEventLogsRequest) Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.
ListEventLogs guarantees events for the last 30 days in a given space. You can also view and retrieve a list of management events over the last 90 days for Amazon CodeCatalyst in the CloudTrail console by viewing Event history, or by creating a trail to create and maintain a record of events that extends past 90 days. For more information, see Working with CloudTrail Event History and Working with CloudTrail trails.
This is a convenience which creates an instance of the
ListEventLogsRequest.Builder
avoiding the need to create one manually viaListEventLogsRequest.builder()
- Parameters:
listEventLogsRequest
- AConsumer
that will call methods onListEventLogsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEventLogs operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventLogsPaginator
This is a variant of
listEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListEventLogsPublisher publisher = client.listEventLogsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListEventLogsPublisher publisher = client.listEventLogsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListEventLogsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation.- Parameters:
listEventLogsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEventLogsPaginator
default ListEventLogsPublisher listEventLogsPaginator(Consumer<ListEventLogsRequest.Builder> listEventLogsRequest) This is a variant of
listEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListEventLogsPublisher publisher = client.listEventLogsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListEventLogsPublisher publisher = client.listEventLogsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListEventLogsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listEventLogs(software.amazon.awssdk.services.codecatalyst.model.ListEventLogsRequest)
operation.
This is a convenience which creates an instance of the
ListEventLogsRequest.Builder
avoiding the need to create one manually viaListEventLogsRequest.builder()
- Parameters:
listEventLogsRequest
- AConsumer
that will call methods onListEventLogsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjects
default CompletableFuture<ListProjectsResponse> listProjects(ListProjectsRequest listProjectsRequest) Retrieves a list of projects.
- Parameters:
listProjectsRequest
-- Returns:
- A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjects
default CompletableFuture<ListProjectsResponse> listProjects(Consumer<ListProjectsRequest.Builder> listProjectsRequest) Retrieves a list of projects.
This is a convenience which creates an instance of the
ListProjectsRequest.Builder
avoiding the need to create one manually viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListProjects operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjectsPaginator
This is a variant of
listProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListProjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListProjectsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation.- Parameters:
listProjectsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listProjectsPaginator
default ListProjectsPublisher listProjectsPaginator(Consumer<ListProjectsRequest.Builder> listProjectsRequest) This is a variant of
listProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListProjectsPublisher publisher = client.listProjectsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListProjectsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListProjectsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProjects(software.amazon.awssdk.services.codecatalyst.model.ListProjectsRequest)
operation.
This is a convenience which creates an instance of the
ListProjectsRequest.Builder
avoiding the need to create one manually viaListProjectsRequest.builder()
- Parameters:
listProjectsRequest
- AConsumer
that will call methods onListProjectsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositories
default CompletableFuture<ListSourceRepositoriesResponse> listSourceRepositories(ListSourceRepositoriesRequest listSourceRepositoriesRequest) Retrieves a list of source repositories in a project.
- Parameters:
listSourceRepositoriesRequest
-- Returns:
- A Java Future containing the result of the ListSourceRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositories
default CompletableFuture<ListSourceRepositoriesResponse> listSourceRepositories(Consumer<ListSourceRepositoriesRequest.Builder> listSourceRepositoriesRequest) Retrieves a list of source repositories in a project.
This is a convenience which creates an instance of the
ListSourceRepositoriesRequest.Builder
avoiding the need to create one manually viaListSourceRepositoriesRequest.builder()
- Parameters:
listSourceRepositoriesRequest
- AConsumer
that will call methods onListSourceRepositoriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSourceRepositories operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoriesPaginator
default ListSourceRepositoriesPublisher listSourceRepositoriesPaginator(ListSourceRepositoriesRequest listSourceRepositoriesRequest) This is a variant of
listSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoriesPublisher publisher = client.listSourceRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoriesPublisher publisher = client.listSourceRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation.- Parameters:
listSourceRepositoriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoriesPaginator
default ListSourceRepositoriesPublisher listSourceRepositoriesPaginator(Consumer<ListSourceRepositoriesRequest.Builder> listSourceRepositoriesRequest) This is a variant of
listSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoriesPublisher publisher = client.listSourceRepositoriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoriesPublisher publisher = client.listSourceRepositoriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceRepositories(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoriesRequest)
operation.
This is a convenience which creates an instance of the
ListSourceRepositoriesRequest.Builder
avoiding the need to create one manually viaListSourceRepositoriesRequest.builder()
- Parameters:
listSourceRepositoriesRequest
- AConsumer
that will call methods onListSourceRepositoriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoryBranches
default CompletableFuture<ListSourceRepositoryBranchesResponse> listSourceRepositoryBranches(ListSourceRepositoryBranchesRequest listSourceRepositoryBranchesRequest) Retrieves a list of branches in a specified source repository.
- Parameters:
listSourceRepositoryBranchesRequest
-- Returns:
- A Java Future containing the result of the ListSourceRepositoryBranches operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoryBranches
default CompletableFuture<ListSourceRepositoryBranchesResponse> listSourceRepositoryBranches(Consumer<ListSourceRepositoryBranchesRequest.Builder> listSourceRepositoryBranchesRequest) Retrieves a list of branches in a specified source repository.
This is a convenience which creates an instance of the
ListSourceRepositoryBranchesRequest.Builder
avoiding the need to create one manually viaListSourceRepositoryBranchesRequest.builder()
- Parameters:
listSourceRepositoryBranchesRequest
- AConsumer
that will call methods onListSourceRepositoryBranchesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSourceRepositoryBranches operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoryBranchesPaginator
default ListSourceRepositoryBranchesPublisher listSourceRepositoryBranchesPaginator(ListSourceRepositoryBranchesRequest listSourceRepositoryBranchesRequest) This is a variant of
listSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoryBranchesPublisher publisher = client.listSourceRepositoryBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoryBranchesPublisher publisher = client.listSourceRepositoryBranchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation.- Parameters:
listSourceRepositoryBranchesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSourceRepositoryBranchesPaginator
default ListSourceRepositoryBranchesPublisher listSourceRepositoryBranchesPaginator(Consumer<ListSourceRepositoryBranchesRequest.Builder> listSourceRepositoryBranchesRequest) This is a variant of
listSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoryBranchesPublisher publisher = client.listSourceRepositoryBranchesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSourceRepositoryBranchesPublisher publisher = client.listSourceRepositoryBranchesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSourceRepositoryBranches(software.amazon.awssdk.services.codecatalyst.model.ListSourceRepositoryBranchesRequest)
operation.
This is a convenience which creates an instance of the
ListSourceRepositoryBranchesRequest.Builder
avoiding the need to create one manually viaListSourceRepositoryBranchesRequest.builder()
- Parameters:
listSourceRepositoryBranchesRequest
- AConsumer
that will call methods onListSourceRepositoryBranchesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpaces
Retrieves a list of spaces.
- Parameters:
listSpacesRequest
-- Returns:
- A Java Future containing the result of the ListSpaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpaces
default CompletableFuture<ListSpacesResponse> listSpaces(Consumer<ListSpacesRequest.Builder> listSpacesRequest) Retrieves a list of spaces.
This is a convenience which creates an instance of the
ListSpacesRequest.Builder
avoiding the need to create one manually viaListSpacesRequest.builder()
- Parameters:
listSpacesRequest
- AConsumer
that will call methods onListSpacesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListSpaces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesPaginator
This is a variant of
listSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSpacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSpacesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation.- Parameters:
listSpacesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesPaginator
default ListSpacesPublisher listSpacesPaginator(Consumer<ListSpacesRequest.Builder> listSpacesRequest) This is a variant of
listSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListSpacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListSpacesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listSpaces(software.amazon.awssdk.services.codecatalyst.model.ListSpacesRequest)
operation.
This is a convenience which creates an instance of the
ListSpacesRequest.Builder
avoiding the need to create one manually viaListSpacesRequest.builder()
- Parameters:
listSpacesRequest
- AConsumer
that will call methods onListSpacesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowRuns
default CompletableFuture<ListWorkflowRunsResponse> listWorkflowRuns(ListWorkflowRunsRequest listWorkflowRunsRequest) Retrieves a list of workflow runs of a specified workflow.
- Parameters:
listWorkflowRunsRequest
-- Returns:
- A Java Future containing the result of the ListWorkflowRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowRuns
default CompletableFuture<ListWorkflowRunsResponse> listWorkflowRuns(Consumer<ListWorkflowRunsRequest.Builder> listWorkflowRunsRequest) Retrieves a list of workflow runs of a specified workflow.
This is a convenience which creates an instance of the
ListWorkflowRunsRequest.Builder
avoiding the need to create one manually viaListWorkflowRunsRequest.builder()
- Parameters:
listWorkflowRunsRequest
- AConsumer
that will call methods onListWorkflowRunsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWorkflowRuns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowRunsPaginator
default ListWorkflowRunsPublisher listWorkflowRunsPaginator(ListWorkflowRunsRequest listWorkflowRunsRequest) This is a variant of
listWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowRunsPublisher publisher = client.listWorkflowRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowRunsPublisher publisher = client.listWorkflowRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation.- Parameters:
listWorkflowRunsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowRunsPaginator
default ListWorkflowRunsPublisher listWorkflowRunsPaginator(Consumer<ListWorkflowRunsRequest.Builder> listWorkflowRunsRequest) This is a variant of
listWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowRunsPublisher publisher = client.listWorkflowRunsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowRunsPublisher publisher = client.listWorkflowRunsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflowRuns(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowRunsRequest)
operation.
This is a convenience which creates an instance of the
ListWorkflowRunsRequest.Builder
avoiding the need to create one manually viaListWorkflowRunsRequest.builder()
- Parameters:
listWorkflowRunsRequest
- AConsumer
that will call methods onListWorkflowRunsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(ListWorkflowsRequest listWorkflowsRequest) Retrieves a list of workflows in a specified project.
- Parameters:
listWorkflowsRequest
-- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflows
default CompletableFuture<ListWorkflowsResponse> listWorkflows(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) Retrieves a list of workflows in a specified project.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builder
avoiding the need to create one manually viaListWorkflowsRequest.builder()
- Parameters:
listWorkflowsRequest
- AConsumer
that will call methods onListWorkflowsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListWorkflows operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
This is a variant of
listWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation.- Parameters:
listWorkflowsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listWorkflowsPaginator
default ListWorkflowsPublisher listWorkflowsPaginator(Consumer<ListWorkflowsRequest.Builder> listWorkflowsRequest) This is a variant of
listWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.codecatalyst.paginators.ListWorkflowsPublisher publisher = client.listWorkflowsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsResponse response) { //... }; });
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listWorkflows(software.amazon.awssdk.services.codecatalyst.model.ListWorkflowsRequest)
operation.
This is a convenience which creates an instance of the
ListWorkflowsRequest.Builder
avoiding the need to create one manually viaListWorkflowsRequest.builder()
- Parameters:
listWorkflowsRequest
- AConsumer
that will call methods onListWorkflowsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDevEnvironment
default CompletableFuture<StartDevEnvironmentResponse> startDevEnvironment(StartDevEnvironmentRequest startDevEnvironmentRequest) Starts a specified Dev Environment and puts it into an active state.
- Parameters:
startDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the StartDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDevEnvironment
default CompletableFuture<StartDevEnvironmentResponse> startDevEnvironment(Consumer<StartDevEnvironmentRequest.Builder> startDevEnvironmentRequest) Starts a specified Dev Environment and puts it into an active state.
This is a convenience which creates an instance of the
StartDevEnvironmentRequest.Builder
avoiding the need to create one manually viaStartDevEnvironmentRequest.builder()
- Parameters:
startDevEnvironmentRequest
- AConsumer
that will call methods onStartDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDevEnvironmentSession
default CompletableFuture<StartDevEnvironmentSessionResponse> startDevEnvironmentSession(StartDevEnvironmentSessionRequest startDevEnvironmentSessionRequest) Starts a session for a specified Dev Environment.
- Parameters:
startDevEnvironmentSessionRequest
-- Returns:
- A Java Future containing the result of the StartDevEnvironmentSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startDevEnvironmentSession
default CompletableFuture<StartDevEnvironmentSessionResponse> startDevEnvironmentSession(Consumer<StartDevEnvironmentSessionRequest.Builder> startDevEnvironmentSessionRequest) Starts a session for a specified Dev Environment.
This is a convenience which creates an instance of the
StartDevEnvironmentSessionRequest.Builder
avoiding the need to create one manually viaStartDevEnvironmentSessionRequest.builder()
- Parameters:
startDevEnvironmentSessionRequest
- AConsumer
that will call methods onStartDevEnvironmentSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartDevEnvironmentSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startWorkflowRun
default CompletableFuture<StartWorkflowRunResponse> startWorkflowRun(StartWorkflowRunRequest startWorkflowRunRequest) Begins a run of a specified workflow.
- Parameters:
startWorkflowRunRequest
-- Returns:
- A Java Future containing the result of the StartWorkflowRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startWorkflowRun
default CompletableFuture<StartWorkflowRunResponse> startWorkflowRun(Consumer<StartWorkflowRunRequest.Builder> startWorkflowRunRequest) Begins a run of a specified workflow.
This is a convenience which creates an instance of the
StartWorkflowRunRequest.Builder
avoiding the need to create one manually viaStartWorkflowRunRequest.builder()
- Parameters:
startWorkflowRunRequest
- AConsumer
that will call methods onStartWorkflowRunRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartWorkflowRun operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDevEnvironment
default CompletableFuture<StopDevEnvironmentResponse> stopDevEnvironment(StopDevEnvironmentRequest stopDevEnvironmentRequest) Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
- Parameters:
stopDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the StopDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDevEnvironment
default CompletableFuture<StopDevEnvironmentResponse> stopDevEnvironment(Consumer<StopDevEnvironmentRequest.Builder> stopDevEnvironmentRequest) Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
This is a convenience which creates an instance of the
StopDevEnvironmentRequest.Builder
avoiding the need to create one manually viaStopDevEnvironmentRequest.builder()
- Parameters:
stopDevEnvironmentRequest
- AConsumer
that will call methods onStopDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDevEnvironmentSession
default CompletableFuture<StopDevEnvironmentSessionResponse> stopDevEnvironmentSession(StopDevEnvironmentSessionRequest stopDevEnvironmentSessionRequest) Stops a session for a specified Dev Environment.
- Parameters:
stopDevEnvironmentSessionRequest
-- Returns:
- A Java Future containing the result of the StopDevEnvironmentSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopDevEnvironmentSession
default CompletableFuture<StopDevEnvironmentSessionResponse> stopDevEnvironmentSession(Consumer<StopDevEnvironmentSessionRequest.Builder> stopDevEnvironmentSessionRequest) Stops a session for a specified Dev Environment.
This is a convenience which creates an instance of the
StopDevEnvironmentSessionRequest.Builder
avoiding the need to create one manually viaStopDevEnvironmentSessionRequest.builder()
- Parameters:
stopDevEnvironmentSessionRequest
- AConsumer
that will call methods onStopDevEnvironmentSessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StopDevEnvironmentSession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDevEnvironment
default CompletableFuture<UpdateDevEnvironmentResponse> updateDevEnvironment(UpdateDevEnvironmentRequest updateDevEnvironmentRequest) Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.
- Parameters:
updateDevEnvironmentRequest
-- Returns:
- A Java Future containing the result of the UpdateDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDevEnvironment
default CompletableFuture<UpdateDevEnvironmentResponse> updateDevEnvironment(Consumer<UpdateDevEnvironmentRequest.Builder> updateDevEnvironmentRequest) Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.
This is a convenience which creates an instance of the
UpdateDevEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateDevEnvironmentRequest.builder()
- Parameters:
updateDevEnvironmentRequest
- AConsumer
that will call methods onUpdateDevEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateDevEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProject
default CompletableFuture<UpdateProjectResponse> updateProject(UpdateProjectRequest updateProjectRequest) Changes one or more values for a project.
- Parameters:
updateProjectRequest
-- Returns:
- A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateProject
default CompletableFuture<UpdateProjectResponse> updateProject(Consumer<UpdateProjectRequest.Builder> updateProjectRequest) Changes one or more values for a project.
This is a convenience which creates an instance of the
UpdateProjectRequest.Builder
avoiding the need to create one manually viaUpdateProjectRequest.builder()
- Parameters:
updateProjectRequest
- AConsumer
that will call methods onUpdateProjectRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateProject operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSpace
Changes one or more values for a space.
- Parameters:
updateSpaceRequest
-- Returns:
- A Java Future containing the result of the UpdateSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSpace
default CompletableFuture<UpdateSpaceResponse> updateSpace(Consumer<UpdateSpaceRequest.Builder> updateSpaceRequest) Changes one or more values for a space.
This is a convenience which creates an instance of the
UpdateSpaceRequest.Builder
avoiding the need to create one manually viaUpdateSpaceRequest.builder()
- Parameters:
updateSpaceRequest
- AConsumer
that will call methods onUpdateSpaceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSpace operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifySession
default CompletableFuture<VerifySessionResponse> verifySession(VerifySessionRequest verifySessionRequest) Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.
- Parameters:
verifySessionRequest
-- Returns:
- A Java Future containing the result of the VerifySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
verifySession
default CompletableFuture<VerifySessionResponse> verifySession(Consumer<VerifySessionRequest.Builder> verifySessionRequest) Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.
This is a convenience which creates an instance of the
VerifySessionRequest.Builder
avoiding the need to create one manually viaVerifySessionRequest.builder()
- Parameters:
verifySessionRequest
- AConsumer
that will call methods onVerifySessionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the VerifySession operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ThrottlingException The request was denied due to request throttling.
- ConflictException The request was denied because the requested operation would cause a conflict with the current state of a service resource associated with the request. Another user might have updated the resource. Reload, make sure you have the latest data, and then try again.
- ValidationException The request was denied because an input failed to satisfy the constraints specified by the service. Check the spelling and input requirements, and then try again.
- ServiceQuotaExceededException The request was denied because one or more resources has reached its limits for the tier the space belongs to. Either reduce the number of resources, or change the tier if applicable.
- ResourceNotFoundException The request was denied because the specified resource was not found. Verify that the spelling is correct and that you have access to the resource.
- AccessDeniedException The request was denied because you don't have sufficient access to perform this action. Verify that you are a member of a role that allows this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- CodeCatalystException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aCodeCatalystAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCodeCatalystAsyncClient
.
-