Interface CloudWatchOmniAsyncClient
- 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.
CloudWatch Omni is a unified observability experience built on Amazon CloudWatch. You work in a space, an isolated environment that holds your telemetry and controls who can access it, and your data is stored in the CloudWatch Dataset for correlated analysis of logs, metrics, and traces.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue 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 aCloudWatchOmniAsyncClient.static CloudWatchOmniAsyncClientcreate()Create aCloudWatchOmniAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createAccessGrant(Consumer<CreateAccessGrantRequest.Builder> createAccessGrantRequest) Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.createAccessGrant(CreateAccessGrantRequest createAccessGrantRequest) Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.createAccessProfile(Consumer<CreateAccessProfileRequest.Builder> createAccessProfileRequest) Creates an access profile in a space.createAccessProfile(CreateAccessProfileRequest createAccessProfileRequest) Creates an access profile in a space.default CompletableFuture<CreateAlertResponse> createAlert(Consumer<CreateAlertRequest.Builder> createAlertRequest) Creates a new alert within a space.default CompletableFuture<CreateAlertResponse> createAlert(CreateAlertRequest createAlertRequest) Creates a new alert within a space.default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain with identity provider configuration.default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest) Creates a domain with identity provider configuration.createDomainAccessGrantForOrganization(Consumer<CreateDomainAccessGrantForOrganizationRequest.Builder> createDomainAccessGrantForOrganizationRequest) Creates an AccessGrant that authorizes a principal to administer an organization domain.createDomainAccessGrantForOrganization(CreateDomainAccessGrantForOrganizationRequest createDomainAccessGrantForOrganizationRequest) Creates an AccessGrant that authorizes a principal to administer an organization domain.createDomainForOrganization(Consumer<CreateDomainForOrganizationRequest.Builder> createDomainForOrganizationRequest) Creates an organization-scoped domain for the caller's AWS Organization.createDomainForOrganization(CreateDomainForOrganizationRequest createDomainForOrganizationRequest) Creates an organization-scoped domain for the caller's AWS Organization.createIntegration(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) Creates an integration with a third-party provider.createIntegration(CreateIntegrationRequest createIntegrationRequest) Creates an integration with a third-party provider.createOmniDashboard(Consumer<CreateOmniDashboardRequest.Builder> createOmniDashboardRequest) Creates a new dashboard within a space.createOmniDashboard(CreateOmniDashboardRequest createOmniDashboardRequest) Creates a new dashboard within a space.createOneTimeDeepLinkCode(Consumer<CreateOneTimeDeepLinkCodeRequest.Builder> createOneTimeDeepLinkCodeRequest) Generates a one-time code for deep-link authentication.createOneTimeDeepLinkCode(CreateOneTimeDeepLinkCodeRequest createOneTimeDeepLinkCodeRequest) Generates a one-time code for deep-link authentication.default CompletableFuture<CreateSpaceResponse> createSpace(Consumer<CreateSpaceRequest.Builder> createSpaceRequest) Creates a space in a domain.default CompletableFuture<CreateSpaceResponse> createSpace(CreateSpaceRequest createSpaceRequest) Creates a space in a domain.default CompletableFuture<CreateViewResponse> createView(Consumer<CreateViewRequest.Builder> createViewRequest) Creates a new SQL view.default CompletableFuture<CreateViewResponse> createView(CreateViewRequest createViewRequest) Creates a new SQL view.deleteAccessGrant(Consumer<DeleteAccessGrantRequest.Builder> deleteAccessGrantRequest) Removes an existing AccessGrant, revoking the access it granted.deleteAccessGrant(DeleteAccessGrantRequest deleteAccessGrantRequest) Removes an existing AccessGrant, revoking the access it granted.deleteAccessProfile(Consumer<DeleteAccessProfileRequest.Builder> deleteAccessProfileRequest) Removes an access profile.deleteAccessProfile(DeleteAccessProfileRequest deleteAccessProfileRequest) Removes an access profile.default CompletableFuture<DeleteAlertResponse> deleteAlert(Consumer<DeleteAlertRequest.Builder> deleteAlertRequest) Deletes an alert by its identifier.default CompletableFuture<DeleteAlertResponse> deleteAlert(DeleteAlertRequest deleteAlertRequest) Deletes an alert by its identifier.default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Removes a domain and all of its resources.default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Removes a domain and all of its resources.deleteDomainAccessGrantForOrganization(Consumer<DeleteDomainAccessGrantForOrganizationRequest.Builder> deleteDomainAccessGrantForOrganizationRequest) Removes an existing organization access grant, revoking the access it granted.deleteDomainAccessGrantForOrganization(DeleteDomainAccessGrantForOrganizationRequest deleteDomainAccessGrantForOrganizationRequest) Removes an existing organization access grant, revoking the access it granted.deleteDomainForOrganization(Consumer<DeleteDomainForOrganizationRequest.Builder> deleteDomainForOrganizationRequest) Removes an organization domain and all of its resources.deleteDomainForOrganization(DeleteDomainForOrganizationRequest deleteDomainForOrganizationRequest) Removes an organization domain and all of its resources.deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Deletes an integration.deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) Deletes an integration.deleteOmniDashboard(Consumer<DeleteOmniDashboardRequest.Builder> deleteOmniDashboardRequest) Removes a dashboard from a space.deleteOmniDashboard(DeleteOmniDashboardRequest deleteOmniDashboardRequest) Removes a dashboard from a space.default CompletableFuture<DeleteSpaceResponse> deleteSpace(Consumer<DeleteSpaceRequest.Builder> deleteSpaceRequest) Removes a space and all of its resources.default CompletableFuture<DeleteSpaceResponse> deleteSpace(DeleteSpaceRequest deleteSpaceRequest) Removes a space and all of its resources.default CompletableFuture<DeleteViewResponse> deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) Deletes the specified view.default CompletableFuture<DeleteViewResponse> deleteView(DeleteViewRequest deleteViewRequest) Deletes the specified view.default CompletableFuture<GetAccessGrantResponse> getAccessGrant(Consumer<GetAccessGrantRequest.Builder> getAccessGrantRequest) Retrieves the full detail of a single AccessGrant by ID.default CompletableFuture<GetAccessGrantResponse> getAccessGrant(GetAccessGrantRequest getAccessGrantRequest) Retrieves the full detail of a single AccessGrant by ID.getAccessProfile(Consumer<GetAccessProfileRequest.Builder> getAccessProfileRequest) Retrieves an access profile by ID.getAccessProfile(GetAccessProfileRequest getAccessProfileRequest) Retrieves an access profile by ID.default CompletableFuture<GetAlertResponse> getAlert(Consumer<GetAlertRequest.Builder> getAlertRequest) Retrieves a single alert by its identifier.default CompletableFuture<GetAlertResponse> getAlert(GetAlertRequest getAlertRequest) Retrieves a single alert by its identifier.default CompletableFuture<GetContextGraphResponse> getContextGraph(Consumer<GetContextGraphRequest.Builder> getContextGraphRequest) Queries the context graph with filtering, traversal, and pagination support.default CompletableFuture<GetContextGraphResponse> getContextGraph(GetContextGraphRequest getContextGraphRequest) Queries the context graph with filtering, traversal, and pagination support.default GetContextGraphPublishergetContextGraphPaginator(Consumer<GetContextGraphRequest.Builder> getContextGraphRequest) This is a variant ofgetContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)operation.default GetContextGraphPublishergetContextGraphPaginator(GetContextGraphRequest getContextGraphRequest) This is a variant ofgetContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)operation.default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) Retrieves the details of a domain by ID.default CompletableFuture<GetDomainResponse> getDomain(GetDomainRequest getDomainRequest) Retrieves the details of a domain by ID.getDomainAccessGrantForOrganization(Consumer<GetDomainAccessGrantForOrganizationRequest.Builder> getDomainAccessGrantForOrganizationRequest) Retrieves the full detail of a single organization access grant by ID.getDomainAccessGrantForOrganization(GetDomainAccessGrantForOrganizationRequest getDomainAccessGrantForOrganizationRequest) Retrieves the full detail of a single organization access grant by ID.getDomainForOrganization(Consumer<GetDomainForOrganizationRequest.Builder> getDomainForOrganizationRequest) Retrieves the details of an organization domain by ID.getDomainForOrganization(GetDomainForOrganizationRequest getDomainForOrganizationRequest) Retrieves the details of an organization domain by ID.default CompletableFuture<GetIntegrationResponse> getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.default CompletableFuture<GetIntegrationResponse> getIntegration(GetIntegrationRequest getIntegrationRequest) Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.getIntelligenceConfiguration(Consumer<GetIntelligenceConfigurationRequest.Builder> getIntelligenceConfigurationRequest) Retrieves the intelligence configuration for the calling account.getIntelligenceConfiguration(GetIntelligenceConfigurationRequest getIntelligenceConfigurationRequest) Retrieves the intelligence configuration for the calling account.getOmniDashboard(Consumer<GetOmniDashboardRequest.Builder> getOmniDashboardRequest) Retrieves a dashboard by ID within a space.getOmniDashboard(GetOmniDashboardRequest getOmniDashboardRequest) Retrieves a dashboard by ID within a space.default CompletableFuture<GetSpaceResponse> getSpace(Consumer<GetSpaceRequest.Builder> getSpaceRequest) Retrieves the details of a space by ID.default CompletableFuture<GetSpaceResponse> getSpace(GetSpaceRequest getSpaceRequest) Retrieves the details of a space by ID.getSpaceCredentialsForOrganization(Consumer<GetSpaceCredentialsForOrganizationRequest.Builder> getSpaceCredentialsForOrganizationRequest) Returns temporary credentials for a space in an organization member account.getSpaceCredentialsForOrganization(GetSpaceCredentialsForOrganizationRequest getSpaceCredentialsForOrganizationRequest) Returns temporary credentials for a space in an organization member account.getTelemetryQueryResults(Consumer<GetTelemetryQueryResultsRequest.Builder> getTelemetryQueryResultsRequest) Returns the results for the specified query.getTelemetryQueryResults(GetTelemetryQueryResultsRequest getTelemetryQueryResultsRequest) Returns the results for the specified query.getTelemetryQueryResultsPaginator(Consumer<GetTelemetryQueryResultsRequest.Builder> getTelemetryQueryResultsRequest) This is a variant ofgetTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)operation.getTelemetryQueryResultsPaginator(GetTelemetryQueryResultsRequest getTelemetryQueryResultsRequest) This is a variant ofgetTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)operation.default CompletableFuture<GetViewResponse> getView(Consumer<GetViewRequest.Builder> getViewRequest) Returns the definition and metadata of the specified view.default CompletableFuture<GetViewResponse> getView(GetViewRequest getViewRequest) Returns the definition and metadata of the specified view.listAccessGrants(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) Returns AccessGrants, with optional filtering by domain, space, principal, or permission.listAccessGrants(ListAccessGrantsRequest listAccessGrantsRequest) Returns AccessGrants, with optional filtering by domain, space, principal, or permission.default ListAccessGrantsPublisherlistAccessGrantsPaginator(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) This is a variant oflistAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)operation.default ListAccessGrantsPublisherlistAccessGrantsPaginator(ListAccessGrantsRequest listAccessGrantsRequest) This is a variant oflistAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)operation.listAccessProfiles(Consumer<ListAccessProfilesRequest.Builder> listAccessProfilesRequest) Returns the access profiles in a space.listAccessProfiles(ListAccessProfilesRequest listAccessProfilesRequest) Returns the access profiles in a space.default ListAccessProfilesPublisherlistAccessProfilesPaginator(Consumer<ListAccessProfilesRequest.Builder> listAccessProfilesRequest) This is a variant oflistAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)operation.default ListAccessProfilesPublisherlistAccessProfilesPaginator(ListAccessProfilesRequest listAccessProfilesRequest) This is a variant oflistAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)operation.default CompletableFuture<ListAlertsResponse> listAlerts(Consumer<ListAlertsRequest.Builder> listAlertsRequest) Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.default CompletableFuture<ListAlertsResponse> listAlerts(ListAlertsRequest listAlertsRequest) Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.default ListAlertsPublisherlistAlertsPaginator(Consumer<ListAlertsRequest.Builder> listAlertsRequest) This is a variant oflistAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)operation.default ListAlertsPublisherlistAlertsPaginator(ListAlertsRequest listAlertsRequest) This is a variant oflistAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)operation.listDomainAccessGrantsForOrganization(Consumer<ListDomainAccessGrantsForOrganizationRequest.Builder> listDomainAccessGrantsForOrganizationRequest) Returns organization-level domain access grants, with optional filtering by domain, principal, or permission.listDomainAccessGrantsForOrganization(ListDomainAccessGrantsForOrganizationRequest listDomainAccessGrantsForOrganizationRequest) Returns organization-level domain access grants, with optional filtering by domain, principal, or permission.listDomainAccessGrantsForOrganizationPaginator(Consumer<ListDomainAccessGrantsForOrganizationRequest.Builder> listDomainAccessGrantsForOrganizationRequest) listDomainAccessGrantsForOrganizationPaginator(ListDomainAccessGrantsForOrganizationRequest listDomainAccessGrantsForOrganizationRequest) default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists.default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest) Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists.default ListDomainsPublisherlistDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)operation.default ListDomainsPublisherlistDomainsPaginator(ListDomainsRequest listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)operation.listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) Lists the integrations in the account, optionally filtered by type, status, or name.listIntegrations(ListIntegrationsRequest listIntegrationsRequest) Lists the integrations in the account, optionally filtered by type, status, or name.default ListIntegrationsPublisherlistIntegrationsPaginator(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) This is a variant oflistIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)operation.default ListIntegrationsPublisherlistIntegrationsPaginator(ListIntegrationsRequest listIntegrationsRequest) This is a variant oflistIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)operation.listOmniDashboards(Consumer<ListOmniDashboardsRequest.Builder> listOmniDashboardsRequest) Returns the dashboards in a space, optionally filtered by name prefix.listOmniDashboards(ListOmniDashboardsRequest listOmniDashboardsRequest) Returns the dashboards in a space, optionally filtered by name prefix.default ListOmniDashboardsPublisherlistOmniDashboardsPaginator(Consumer<ListOmniDashboardsRequest.Builder> listOmniDashboardsRequest) This is a variant oflistOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)operation.default ListOmniDashboardsPublisherlistOmniDashboardsPaginator(ListOmniDashboardsRequest listOmniDashboardsRequest) This is a variant oflistOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)operation.default CompletableFuture<ListSpacesResponse> listSpaces(Consumer<ListSpacesRequest.Builder> listSpacesRequest) Returns the spaces in the account, optionally filtered by domain.default CompletableFuture<ListSpacesResponse> listSpaces(ListSpacesRequest listSpacesRequest) Returns the spaces in the account, optionally filtered by domain.listSpacesForOrganization(Consumer<ListSpacesForOrganizationRequest.Builder> listSpacesForOrganizationRequest) Returns the spaces across all member accounts in the organization.listSpacesForOrganization(ListSpacesForOrganizationRequest listSpacesForOrganizationRequest) Returns the spaces across all member accounts in the organization.listSpacesForOrganizationPaginator(Consumer<ListSpacesForOrganizationRequest.Builder> listSpacesForOrganizationRequest) This is a variant oflistSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)operation.listSpacesForOrganizationPaginator(ListSpacesForOrganizationRequest listSpacesForOrganizationRequest) This is a variant oflistSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)operation.default ListSpacesPublisherlistSpacesPaginator(Consumer<ListSpacesRequest.Builder> listSpacesRequest) This is a variant oflistSpaces(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesRequest)operation.default ListSpacesPublisherlistSpacesPaginator(ListSpacesRequest listSpacesRequest) This is a variant oflistSpaces(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesRequest)operation.listTelemetryFields(Consumer<ListTelemetryFieldsRequest.Builder> listTelemetryFieldsRequest) Lists fields available for telemetry queries.listTelemetryFields(ListTelemetryFieldsRequest listTelemetryFieldsRequest) Lists fields available for telemetry queries.default ListTelemetryFieldsPublisherlistTelemetryFieldsPaginator(Consumer<ListTelemetryFieldsRequest.Builder> listTelemetryFieldsRequest) This is a variant oflistTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)operation.default ListTelemetryFieldsPublisherlistTelemetryFieldsPaginator(ListTelemetryFieldsRequest listTelemetryFieldsRequest) This is a variant oflistTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)operation.listTelemetryQuerySessions(Consumer<ListTelemetryQuerySessionsRequest.Builder> listTelemetryQuerySessionsRequest) Lists telemetry query sessions.listTelemetryQuerySessions(ListTelemetryQuerySessionsRequest listTelemetryQuerySessionsRequest) Lists telemetry query sessions.listTelemetryQuerySessionsPaginator(Consumer<ListTelemetryQuerySessionsRequest.Builder> listTelemetryQuerySessionsRequest) This is a variant oflistTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)operation.listTelemetryQuerySessionsPaginator(ListTelemetryQuerySessionsRequest listTelemetryQuerySessionsRequest) This is a variant oflistTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)operation.default CompletableFuture<ListViewsResponse> listViews(Consumer<ListViewsRequest.Builder> listViewsRequest) Lists the views in the caller's account and region.default CompletableFuture<ListViewsResponse> listViews(ListViewsRequest listViewsRequest) Lists the views in the caller's account and region.default ListViewsPublisherlistViewsPaginator(Consumer<ListViewsRequest.Builder> listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)operation.default ListViewsPublisherlistViewsPaginator(ListViewsRequest listViewsRequest) This is a variant oflistViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)operation.putIntelligenceConfiguration(Consumer<PutIntelligenceConfigurationRequest.Builder> putIntelligenceConfigurationRequest) Creates or updates the intelligence configuration for the calling account.putIntelligenceConfiguration(PutIntelligenceConfigurationRequest putIntelligenceConfigurationRequest) Creates or updates the intelligence configuration for the calling account.searchPrincipals(Consumer<SearchPrincipalsRequest.Builder> searchPrincipalsRequest) Searches Identity Center for users and groups in a domain.searchPrincipals(SearchPrincipalsRequest searchPrincipalsRequest) Searches Identity Center for users and groups in a domain.default SearchPrincipalsPublishersearchPrincipalsPaginator(Consumer<SearchPrincipalsRequest.Builder> searchPrincipalsRequest) This is a variant ofsearchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)operation.default SearchPrincipalsPublishersearchPrincipalsPaginator(SearchPrincipalsRequest searchPrincipalsRequest) This is a variant ofsearchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartTelemetryQuery(Consumer<StartTelemetryQueryRequest.Builder> startTelemetryQueryRequest) Starts a telemetry query within a session.startTelemetryQuery(StartTelemetryQueryRequest startTelemetryQueryRequest) Starts a telemetry query within a session.startTelemetryQuerySession(Consumer<StartTelemetryQuerySessionRequest.Builder> startTelemetryQuerySessionRequest) Starts a new telemetry query session.startTelemetryQuerySession(StartTelemetryQuerySessionRequest startTelemetryQuerySessionRequest) Starts a new telemetry query session.stopTelemetryQuery(Consumer<StopTelemetryQueryRequest.Builder> stopTelemetryQueryRequest) Stops a running telemetry query.stopTelemetryQuery(StopTelemetryQueryRequest stopTelemetryQueryRequest) Stops a running telemetry query.stopTelemetryQuerySession(Consumer<StopTelemetryQuerySessionRequest.Builder> stopTelemetryQuerySessionRequest) Stops a telemetry query session.stopTelemetryQuerySession(StopTelemetryQuerySessionRequest stopTelemetryQuerySessionRequest) Stops a telemetry query session.updateAccessProfile(Consumer<UpdateAccessProfileRequest.Builder> updateAccessProfileRequest) Updates the name or description of an access profile.updateAccessProfile(UpdateAccessProfileRequest updateAccessProfileRequest) Updates the name or description of an access profile.default CompletableFuture<UpdateAlertResponse> updateAlert(Consumer<UpdateAlertRequest.Builder> updateAlertRequest) Updates an existing alert.default CompletableFuture<UpdateAlertResponse> updateAlert(UpdateAlertRequest updateAlertRequest) Updates an existing alert.default CompletableFuture<UpdateDomainResponse> updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) Updates a domain's name or identity provider configuration.default CompletableFuture<UpdateDomainResponse> updateDomain(UpdateDomainRequest updateDomainRequest) Updates a domain's name or identity provider configuration.updateDomainForOrganization(Consumer<UpdateDomainForOrganizationRequest.Builder> updateDomainForOrganizationRequest) Updates an organization domain's name or identity provider configuration.updateDomainForOrganization(UpdateDomainForOrganizationRequest updateDomainForOrganizationRequest) Updates an organization domain's name or identity provider configuration.updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) Updates an existing integration, identified by its id, ARN, or name.updateIntegration(UpdateIntegrationRequest updateIntegrationRequest) Updates an existing integration, identified by its id, ARN, or name.updateOmniDashboard(Consumer<UpdateOmniDashboardRequest.Builder> updateOmniDashboardRequest) Updates an existing dashboard within a space.updateOmniDashboard(UpdateOmniDashboardRequest updateOmniDashboardRequest) Updates an existing dashboard within a space.default CompletableFuture<UpdateSpaceResponse> updateSpace(Consumer<UpdateSpaceRequest.Builder> updateSpaceRequest) Updates a space.default CompletableFuture<UpdateSpaceResponse> updateSpace(UpdateSpaceRequest updateSpaceRequest) Updates a space.default CompletableFuture<UpdateViewResponse> updateView(Consumer<UpdateViewRequest.Builder> updateViewRequest) Updates an existing view's definition and/or description.default CompletableFuture<UpdateViewResponse> updateView(UpdateViewRequest updateViewRequest) Updates an existing view's definition and/or description.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
createAccessGrant
default CompletableFuture<CreateAccessGrantResponse> createAccessGrant(CreateAccessGrantRequest createAccessGrantRequest) Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.
Optionally narrow the grant with scoped actions that limit it to specific resources and fields. Use ListAccessGrants and GetAccessGrant to retrieve grants, and DeleteAccessGrant to remove them.
- Parameters:
createAccessGrantRequest-- Returns:
- A Java Future containing the result of the CreateAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessGrant
default CompletableFuture<CreateAccessGrantResponse> createAccessGrant(Consumer<CreateAccessGrantRequest.Builder> createAccessGrantRequest) Creates an AccessGrant that authorizes a principal to perform a set of actions on resources in a space.
Optionally narrow the grant with scoped actions that limit it to specific resources and fields. Use ListAccessGrants and GetAccessGrant to retrieve grants, and DeleteAccessGrant to remove them.
This is a convenience which creates an instance of the
CreateAccessGrantRequest.Builderavoiding the need to create one manually viaCreateAccessGrantRequest.builder()- Parameters:
createAccessGrantRequest- AConsumerthat will call methods onCreateAccessGrantRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessProfile
default CompletableFuture<CreateAccessProfileResponse> createAccessProfile(CreateAccessProfileRequest createAccessProfileRequest) Creates an access profile in a space.
Use GetAccessProfile and ListAccessProfiles to retrieve profiles, and UpdateAccessProfile to modify one.
- Parameters:
createAccessProfileRequest-- Returns:
- A Java Future containing the result of the CreateAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAccessProfile
default CompletableFuture<CreateAccessProfileResponse> createAccessProfile(Consumer<CreateAccessProfileRequest.Builder> createAccessProfileRequest) Creates an access profile in a space.
Use GetAccessProfile and ListAccessProfiles to retrieve profiles, and UpdateAccessProfile to modify one.
This is a convenience which creates an instance of the
CreateAccessProfileRequest.Builderavoiding the need to create one manually viaCreateAccessProfileRequest.builder()- Parameters:
createAccessProfileRequest- AConsumerthat will call methods onCreateAccessProfileRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlert
Creates a new alert within a space.
Use GetAlert and ListAlerts to retrieve alerts, UpdateAlert to modify one, and DeleteAlert to remove it.
- Parameters:
createAlertRequest-- Returns:
- A Java Future containing the result of the CreateAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createAlert
default CompletableFuture<CreateAlertResponse> createAlert(Consumer<CreateAlertRequest.Builder> createAlertRequest) Creates a new alert within a space.
Use GetAlert and ListAlerts to retrieve alerts, UpdateAlert to modify one, and DeleteAlert to remove it.
This is a convenience which creates an instance of the
CreateAlertRequest.Builderavoiding the need to create one manually viaCreateAlertRequest.builder()- Parameters:
createAlertRequest- AConsumerthat will call methods onCreateAlertRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(CreateDomainRequest createDomainRequest) Creates a domain with identity provider configuration.
Use GetDomain to retrieve the domain, UpdateDomain to change its configuration, and CreateSpace to add spaces within it.
- Parameters:
createDomainRequest-- Returns:
- A Java Future containing the result of the CreateDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomain
default CompletableFuture<CreateDomainResponse> createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates a domain with identity provider configuration.
Use GetDomain to retrieve the domain, UpdateDomain to change its configuration, and CreateSpace to add spaces within it.
This is a convenience which creates an instance of the
CreateDomainRequest.Builderavoiding the need to create one manually viaCreateDomainRequest.builder()- Parameters:
createDomainRequest- AConsumerthat will call methods onCreateDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainAccessGrantForOrganization
default CompletableFuture<CreateDomainAccessGrantForOrganizationResponse> createDomainAccessGrantForOrganization(CreateDomainAccessGrantForOrganizationRequest createDomainAccessGrantForOrganizationRequest) Creates an AccessGrant that authorizes a principal to administer an organization domain.
- Parameters:
createDomainAccessGrantForOrganizationRequest-- Returns:
- A Java Future containing the result of the CreateDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainAccessGrantForOrganization
default CompletableFuture<CreateDomainAccessGrantForOrganizationResponse> createDomainAccessGrantForOrganization(Consumer<CreateDomainAccessGrantForOrganizationRequest.Builder> createDomainAccessGrantForOrganizationRequest) Creates an AccessGrant that authorizes a principal to administer an organization domain.
This is a convenience which creates an instance of the
CreateDomainAccessGrantForOrganizationRequest.Builderavoiding the need to create one manually viaCreateDomainAccessGrantForOrganizationRequest.builder()- Parameters:
createDomainAccessGrantForOrganizationRequest- AConsumerthat will call methods onCreateDomainAccessGrantForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainForOrganization
default CompletableFuture<CreateDomainForOrganizationResponse> createDomainForOrganization(CreateDomainForOrganizationRequest createDomainForOrganizationRequest) Creates an organization-scoped domain for the caller's AWS Organization. Only the organization's management account can call this operation.
- Parameters:
createDomainForOrganizationRequest-- Returns:
- A Java Future containing the result of the CreateDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDomainForOrganization
default CompletableFuture<CreateDomainForOrganizationResponse> createDomainForOrganization(Consumer<CreateDomainForOrganizationRequest.Builder> createDomainForOrganizationRequest) Creates an organization-scoped domain for the caller's AWS Organization. Only the organization's management account can call this operation.
This is a convenience which creates an instance of the
CreateDomainForOrganizationRequest.Builderavoiding the need to create one manually viaCreateDomainForOrganizationRequest.builder()- Parameters:
createDomainForOrganizationRequest- AConsumerthat will call methods onCreateDomainForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIntegration
default CompletableFuture<CreateIntegrationResponse> createIntegration(CreateIntegrationRequest createIntegrationRequest) Creates an integration with a third-party provider. Returns the integration identifier and its initial status; when the provider requires interactive consent, an authorization URL is returned for the user to complete setup.
- Parameters:
createIntegrationRequest- The request for creating an integration with a third-party provider.- Returns:
- A Java Future containing the result of the CreateIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createIntegration
default CompletableFuture<CreateIntegrationResponse> createIntegration(Consumer<CreateIntegrationRequest.Builder> createIntegrationRequest) Creates an integration with a third-party provider. Returns the integration identifier and its initial status; when the provider requires interactive consent, an authorization URL is returned for the user to complete setup.
This is a convenience which creates an instance of the
CreateIntegrationRequest.Builderavoiding the need to create one manually viaCreateIntegrationRequest.builder()- Parameters:
createIntegrationRequest- AConsumerthat will call methods onCreateIntegrationRequest.Builderto create a request. The request for creating an integration with a third-party provider.- Returns:
- A Java Future containing the result of the CreateIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOmniDashboard
default CompletableFuture<CreateOmniDashboardResponse> createOmniDashboard(CreateOmniDashboardRequest createOmniDashboardRequest) Creates a new dashboard within a space.
Use GetOmniDashboard and ListOmniDashboards to retrieve dashboards, UpdateOmniDashboard to modify one, and DeleteOmniDashboard to remove it.
- Parameters:
createOmniDashboardRequest-- Returns:
- A Java Future containing the result of the CreateOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOmniDashboard
default CompletableFuture<CreateOmniDashboardResponse> createOmniDashboard(Consumer<CreateOmniDashboardRequest.Builder> createOmniDashboardRequest) Creates a new dashboard within a space.
Use GetOmniDashboard and ListOmniDashboards to retrieve dashboards, UpdateOmniDashboard to modify one, and DeleteOmniDashboard to remove it.
This is a convenience which creates an instance of the
CreateOmniDashboardRequest.Builderavoiding the need to create one manually viaCreateOmniDashboardRequest.builder()- Parameters:
createOmniDashboardRequest- AConsumerthat will call methods onCreateOmniDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOneTimeDeepLinkCode
default CompletableFuture<CreateOneTimeDeepLinkCodeResponse> createOneTimeDeepLinkCode(CreateOneTimeDeepLinkCodeRequest createOneTimeDeepLinkCodeRequest) Generates a one-time code for deep-link authentication.
Direct the user's browser to the returned deepLinkUrl before it expires. The code is exchanged for an authenticated, domain-scoped session and can be used only once.
- Parameters:
createOneTimeDeepLinkCodeRequest-- Returns:
- A Java Future containing the result of the CreateOneTimeDeepLinkCode 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createOneTimeDeepLinkCode
default CompletableFuture<CreateOneTimeDeepLinkCodeResponse> createOneTimeDeepLinkCode(Consumer<CreateOneTimeDeepLinkCodeRequest.Builder> createOneTimeDeepLinkCodeRequest) Generates a one-time code for deep-link authentication.
Direct the user's browser to the returned deepLinkUrl before it expires. The code is exchanged for an authenticated, domain-scoped session and can be used only once.
This is a convenience which creates an instance of the
CreateOneTimeDeepLinkCodeRequest.Builderavoiding the need to create one manually viaCreateOneTimeDeepLinkCodeRequest.builder()- Parameters:
createOneTimeDeepLinkCodeRequest- AConsumerthat will call methods onCreateOneTimeDeepLinkCodeRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateOneTimeDeepLinkCode 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSpace
Creates a space in a domain.
Use GetSpace to retrieve the space, ListSpaces to enumerate spaces, UpdateSpace to modify it, and DeleteSpace to remove it.
- Parameters:
createSpaceRequest-- Returns:
- A Java Future containing the result of the CreateSpace 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSpace
default CompletableFuture<CreateSpaceResponse> createSpace(Consumer<CreateSpaceRequest.Builder> createSpaceRequest) Creates a space in a domain.
Use GetSpace to retrieve the space, ListSpaces to enumerate spaces, UpdateSpace to modify it, and DeleteSpace to remove it.
This is a convenience which creates an instance of the
CreateSpaceRequest.Builderavoiding the need to create one manually viaCreateSpaceRequest.builder()- Parameters:
createSpaceRequest- AConsumerthat will call methods onCreateSpaceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateSpace 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createView
Creates a new SQL view.
A view is a named, reusable SQL query that can be referenced from telemetry queries. View names must be unique within the account and region. Only USER views can be created — MANAGED views are provisioned by AWS.
- Parameters:
createViewRequest-- Returns:
- A Java Future containing the result of the CreateView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createView
default CompletableFuture<CreateViewResponse> createView(Consumer<CreateViewRequest.Builder> createViewRequest) Creates a new SQL view.
A view is a named, reusable SQL query that can be referenced from telemetry queries. View names must be unique within the account and region. Only USER views can be created — MANAGED views are provisioned by AWS.
This is a convenience which creates an instance of the
CreateViewRequest.Builderavoiding the need to create one manually viaCreateViewRequest.builder()- Parameters:
createViewRequest- AConsumerthat will call methods onCreateViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessGrant
default CompletableFuture<DeleteAccessGrantResponse> deleteAccessGrant(DeleteAccessGrantRequest deleteAccessGrantRequest) Removes an existing AccessGrant, revoking the access it granted.
A service-managed grant cannot be deleted.
- Parameters:
deleteAccessGrantRequest-- Returns:
- A Java Future containing the result of the DeleteAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessGrant
default CompletableFuture<DeleteAccessGrantResponse> deleteAccessGrant(Consumer<DeleteAccessGrantRequest.Builder> deleteAccessGrantRequest) Removes an existing AccessGrant, revoking the access it granted.
A service-managed grant cannot be deleted.
This is a convenience which creates an instance of the
DeleteAccessGrantRequest.Builderavoiding the need to create one manually viaDeleteAccessGrantRequest.builder()- Parameters:
deleteAccessGrantRequest- AConsumerthat will call methods onDeleteAccessGrantRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessProfile
default CompletableFuture<DeleteAccessProfileResponse> deleteAccessProfile(DeleteAccessProfileRequest deleteAccessProfileRequest) Removes an access profile.
An access profile cannot be deleted while access grants reference it.
- Parameters:
deleteAccessProfileRequest-- Returns:
- A Java Future containing the result of the DeleteAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAccessProfile
default CompletableFuture<DeleteAccessProfileResponse> deleteAccessProfile(Consumer<DeleteAccessProfileRequest.Builder> deleteAccessProfileRequest) Removes an access profile.
An access profile cannot be deleted while access grants reference it.
This is a convenience which creates an instance of the
DeleteAccessProfileRequest.Builderavoiding the need to create one manually viaDeleteAccessProfileRequest.builder()- Parameters:
deleteAccessProfileRequest- AConsumerthat will call methods onDeleteAccessProfileRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlert
Deletes an alert by its identifier.
Idempotent: deleting an alert that has already been removed succeeds without error.
- Parameters:
deleteAlertRequest-- Returns:
- A Java Future containing the result of the DeleteAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAlert
default CompletableFuture<DeleteAlertResponse> deleteAlert(Consumer<DeleteAlertRequest.Builder> deleteAlertRequest) Deletes an alert by its identifier.
Idempotent: deleting an alert that has already been removed succeeds without error.
This is a convenience which creates an instance of the
DeleteAlertRequest.Builderavoiding the need to create one manually viaDeleteAlertRequest.builder()- Parameters:
deleteAlertRequest- AConsumerthat will call methods onDeleteAlertRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(DeleteDomainRequest deleteDomainRequest) Removes a domain and all of its resources. Call this operation in the Region where the domain was created.
A domain cannot be deleted while it contains spaces.
- Parameters:
deleteDomainRequest-- Returns:
- A Java Future containing the result of the DeleteDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomain
default CompletableFuture<DeleteDomainResponse> deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Removes a domain and all of its resources. Call this operation in the Region where the domain was created.
A domain cannot be deleted while it contains spaces.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builderavoiding the need to create one manually viaDeleteDomainRequest.builder()- Parameters:
deleteDomainRequest- AConsumerthat will call methods onDeleteDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainAccessGrantForOrganization
default CompletableFuture<DeleteDomainAccessGrantForOrganizationResponse> deleteDomainAccessGrantForOrganization(DeleteDomainAccessGrantForOrganizationRequest deleteDomainAccessGrantForOrganizationRequest) Removes an existing organization access grant, revoking the access it granted.
A service-managed grant cannot be deleted.
- Parameters:
deleteDomainAccessGrantForOrganizationRequest-- Returns:
- A Java Future containing the result of the DeleteDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainAccessGrantForOrganization
default CompletableFuture<DeleteDomainAccessGrantForOrganizationResponse> deleteDomainAccessGrantForOrganization(Consumer<DeleteDomainAccessGrantForOrganizationRequest.Builder> deleteDomainAccessGrantForOrganizationRequest) Removes an existing organization access grant, revoking the access it granted.
A service-managed grant cannot be deleted.
This is a convenience which creates an instance of the
DeleteDomainAccessGrantForOrganizationRequest.Builderavoiding the need to create one manually viaDeleteDomainAccessGrantForOrganizationRequest.builder()- Parameters:
deleteDomainAccessGrantForOrganizationRequest- AConsumerthat will call methods onDeleteDomainAccessGrantForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainForOrganization
default CompletableFuture<DeleteDomainForOrganizationResponse> deleteDomainForOrganization(DeleteDomainForOrganizationRequest deleteDomainForOrganizationRequest) Removes an organization domain and all of its resources. Call this operation in the Region where the domain was created.
A domain cannot be deleted while it contains spaces.
- Parameters:
deleteDomainForOrganizationRequest-- Returns:
- A Java Future containing the result of the DeleteDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDomainForOrganization
default CompletableFuture<DeleteDomainForOrganizationResponse> deleteDomainForOrganization(Consumer<DeleteDomainForOrganizationRequest.Builder> deleteDomainForOrganizationRequest) Removes an organization domain and all of its resources. Call this operation in the Region where the domain was created.
A domain cannot be deleted while it contains spaces.
This is a convenience which creates an instance of the
DeleteDomainForOrganizationRequest.Builderavoiding the need to create one manually viaDeleteDomainForOrganizationRequest.builder()- Parameters:
deleteDomainForOrganizationRequest- AConsumerthat will call methods onDeleteDomainForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntegration
default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(DeleteIntegrationRequest deleteIntegrationRequest) Deletes an integration. Returns the resulting status.
- Parameters:
deleteIntegrationRequest- The request for deleting an integration.- Returns:
- A Java Future containing the result of the DeleteIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteIntegration
default CompletableFuture<DeleteIntegrationResponse> deleteIntegration(Consumer<DeleteIntegrationRequest.Builder> deleteIntegrationRequest) Deletes an integration. Returns the resulting status.
This is a convenience which creates an instance of the
DeleteIntegrationRequest.Builderavoiding the need to create one manually viaDeleteIntegrationRequest.builder()- Parameters:
deleteIntegrationRequest- AConsumerthat will call methods onDeleteIntegrationRequest.Builderto create a request. The request for deleting an integration.- Returns:
- A Java Future containing the result of the DeleteIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOmniDashboard
default CompletableFuture<DeleteOmniDashboardResponse> deleteOmniDashboard(DeleteOmniDashboardRequest deleteOmniDashboardRequest) Removes a dashboard from a space.
- Parameters:
deleteOmniDashboardRequest-- Returns:
- A Java Future containing the result of the DeleteOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOmniDashboard
default CompletableFuture<DeleteOmniDashboardResponse> deleteOmniDashboard(Consumer<DeleteOmniDashboardRequest.Builder> deleteOmniDashboardRequest) Removes a dashboard from a space.
This is a convenience which creates an instance of the
DeleteOmniDashboardRequest.Builderavoiding the need to create one manually viaDeleteOmniDashboardRequest.builder()- Parameters:
deleteOmniDashboardRequest- AConsumerthat will call methods onDeleteOmniDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSpace
Removes a space and all of its resources.
- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException 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) Removes a space and all of its resources.
This is a convenience which creates an instance of the
DeleteSpaceRequest.Builderavoiding the need to create one manually viaDeleteSpaceRequest.builder()- Parameters:
deleteSpaceRequest- AConsumerthat will call methods onDeleteSpaceRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteView
Deletes the specified view.
Queries that reference the view fail after it is deleted. Managed views cannot be deleted.
- Parameters:
deleteViewRequest-- Returns:
- A Java Future containing the result of the DeleteView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteView
default CompletableFuture<DeleteViewResponse> deleteView(Consumer<DeleteViewRequest.Builder> deleteViewRequest) Deletes the specified view.
Queries that reference the view fail after it is deleted. Managed views cannot be deleted.
This is a convenience which creates an instance of the
DeleteViewRequest.Builderavoiding the need to create one manually viaDeleteViewRequest.builder()- Parameters:
deleteViewRequest- AConsumerthat will call methods onDeleteViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessGrant
default CompletableFuture<GetAccessGrantResponse> getAccessGrant(GetAccessGrantRequest getAccessGrantRequest) Retrieves the full detail of a single AccessGrant by ID.
- Parameters:
getAccessGrantRequest-- Returns:
- A Java Future containing the result of the GetAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessGrant
default CompletableFuture<GetAccessGrantResponse> getAccessGrant(Consumer<GetAccessGrantRequest.Builder> getAccessGrantRequest) Retrieves the full detail of a single AccessGrant by ID.
This is a convenience which creates an instance of the
GetAccessGrantRequest.Builderavoiding the need to create one manually viaGetAccessGrantRequest.builder()- Parameters:
getAccessGrantRequest- AConsumerthat will call methods onGetAccessGrantRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAccessGrant 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessProfile
default CompletableFuture<GetAccessProfileResponse> getAccessProfile(GetAccessProfileRequest getAccessProfileRequest) Retrieves an access profile by ID.
The response indicates whether the calling principal is currently allowed to assume the profile.
- Parameters:
getAccessProfileRequest-- Returns:
- A Java Future containing the result of the GetAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAccessProfile
default CompletableFuture<GetAccessProfileResponse> getAccessProfile(Consumer<GetAccessProfileRequest.Builder> getAccessProfileRequest) Retrieves an access profile by ID.
The response indicates whether the calling principal is currently allowed to assume the profile.
This is a convenience which creates an instance of the
GetAccessProfileRequest.Builderavoiding the need to create one manually viaGetAccessProfileRequest.builder()- Parameters:
getAccessProfileRequest- AConsumerthat will call methods onGetAccessProfileRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAlert
Retrieves a single alert by its identifier.
Use ListAlerts to enumerate alerts in the space.
- Parameters:
getAlertRequest-- Returns:
- A Java Future containing the result of the GetAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAlert
default CompletableFuture<GetAlertResponse> getAlert(Consumer<GetAlertRequest.Builder> getAlertRequest) Retrieves a single alert by its identifier.
Use ListAlerts to enumerate alerts in the space.
This is a convenience which creates an instance of the
GetAlertRequest.Builderavoiding the need to create one manually viaGetAlertRequest.builder()- Parameters:
getAlertRequest- AConsumerthat will call methods onGetAlertRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContextGraph
default CompletableFuture<GetContextGraphResponse> getContextGraph(GetContextGraphRequest getContextGraphRequest) Queries the context graph with filtering, traversal, and pagination support.
Pagination note: nodes and edges are returned together as a coherent subgraph. Pagination cursors advance over nodes (the primary collection); each page includes all edges connecting nodes within that page. Callers should treat nodes as the paginated collection and edges as supplementary relationship data attached to those nodes.
- Parameters:
getContextGraphRequest- The request for retrieving a slice of the context graph.- Returns:
- A Java Future containing the result of the GetContextGraph 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContextGraph
default CompletableFuture<GetContextGraphResponse> getContextGraph(Consumer<GetContextGraphRequest.Builder> getContextGraphRequest) Queries the context graph with filtering, traversal, and pagination support.
Pagination note: nodes and edges are returned together as a coherent subgraph. Pagination cursors advance over nodes (the primary collection); each page includes all edges connecting nodes within that page. Callers should treat nodes as the paginated collection and edges as supplementary relationship data attached to those nodes.
This is a convenience which creates an instance of the
GetContextGraphRequest.Builderavoiding the need to create one manually viaGetContextGraphRequest.builder()- Parameters:
getContextGraphRequest- AConsumerthat will call methods onGetContextGraphRequest.Builderto create a request. The request for retrieving a slice of the context graph.- Returns:
- A Java Future containing the result of the GetContextGraph 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContextGraphPaginator
default GetContextGraphPublisher getContextGraphPaginator(GetContextGraphRequest getContextGraphRequest) This is a variant of
getContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.GetContextGraphPublisher publisher = client.getContextGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.GetContextGraphPublisher publisher = client.getContextGraphPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphResponse 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
getContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)operation.- Parameters:
getContextGraphRequest- The request for retrieving a slice of the context graph.- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getContextGraphPaginator
default GetContextGraphPublisher getContextGraphPaginator(Consumer<GetContextGraphRequest.Builder> getContextGraphRequest) This is a variant of
getContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.GetContextGraphPublisher publisher = client.getContextGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.GetContextGraphPublisher publisher = client.getContextGraphPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphResponse 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
getContextGraph(software.amazon.awssdk.services.cloudwatchomni.model.GetContextGraphRequest)operation.
This is a convenience which creates an instance of the
GetContextGraphRequest.Builderavoiding the need to create one manually viaGetContextGraphRequest.builder()- Parameters:
getContextGraphRequest- AConsumerthat will call methods onGetContextGraphRequest.Builderto create a request. The request for retrieving a slice of the context graph.- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomain
Retrieves the details of a domain by ID.
- Parameters:
getDomainRequest-- Returns:
- A Java Future containing the result of the GetDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomain
default CompletableFuture<GetDomainResponse> getDomain(Consumer<GetDomainRequest.Builder> getDomainRequest) Retrieves the details of a domain by ID.
This is a convenience which creates an instance of the
GetDomainRequest.Builderavoiding the need to create one manually viaGetDomainRequest.builder()- Parameters:
getDomainRequest- AConsumerthat will call methods onGetDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainAccessGrantForOrganization
default CompletableFuture<GetDomainAccessGrantForOrganizationResponse> getDomainAccessGrantForOrganization(GetDomainAccessGrantForOrganizationRequest getDomainAccessGrantForOrganizationRequest) Retrieves the full detail of a single organization access grant by ID.
- Parameters:
getDomainAccessGrantForOrganizationRequest-- Returns:
- A Java Future containing the result of the GetDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainAccessGrantForOrganization
default CompletableFuture<GetDomainAccessGrantForOrganizationResponse> getDomainAccessGrantForOrganization(Consumer<GetDomainAccessGrantForOrganizationRequest.Builder> getDomainAccessGrantForOrganizationRequest) Retrieves the full detail of a single organization access grant by ID.
This is a convenience which creates an instance of the
GetDomainAccessGrantForOrganizationRequest.Builderavoiding the need to create one manually viaGetDomainAccessGrantForOrganizationRequest.builder()- Parameters:
getDomainAccessGrantForOrganizationRequest- AConsumerthat will call methods onGetDomainAccessGrantForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDomainAccessGrantForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainForOrganization
default CompletableFuture<GetDomainForOrganizationResponse> getDomainForOrganization(GetDomainForOrganizationRequest getDomainForOrganizationRequest) Retrieves the details of an organization domain by ID.
- Parameters:
getDomainForOrganizationRequest-- Returns:
- A Java Future containing the result of the GetDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDomainForOrganization
default CompletableFuture<GetDomainForOrganizationResponse> getDomainForOrganization(Consumer<GetDomainForOrganizationRequest.Builder> getDomainForOrganizationRequest) Retrieves the details of an organization domain by ID.
This is a convenience which creates an instance of the
GetDomainForOrganizationRequest.Builderavoiding the need to create one manually viaGetDomainForOrganizationRequest.builder()- Parameters:
getDomainForOrganizationRequest- AConsumerthat will call methods onGetDomainForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntegration
default CompletableFuture<GetIntegrationResponse> getIntegration(GetIntegrationRequest getIntegrationRequest) Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.
- Parameters:
getIntegrationRequest- The request for retrieving a single integration.- Returns:
- A Java Future containing the result of the GetIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntegration
default CompletableFuture<GetIntegrationResponse> getIntegration(Consumer<GetIntegrationRequest.Builder> getIntegrationRequest) Returns the details of a single integration, identified by its identifier, Amazon Resource Name, or name.
This is a convenience which creates an instance of the
GetIntegrationRequest.Builderavoiding the need to create one manually viaGetIntegrationRequest.builder()- Parameters:
getIntegrationRequest- AConsumerthat will call methods onGetIntegrationRequest.Builderto create a request. The request for retrieving a single integration.- Returns:
- A Java Future containing the result of the GetIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntelligenceConfiguration
default CompletableFuture<GetIntelligenceConfigurationResponse> getIntelligenceConfiguration(GetIntelligenceConfigurationRequest getIntelligenceConfigurationRequest) Retrieves the intelligence configuration for the calling account. Account is identified via FAS (caller identity). Returns the default configuration if none exists yet.
- Parameters:
getIntelligenceConfigurationRequest- The request for retrieving the intelligence configuration of the calling account.- Returns:
- A Java Future containing the result of the GetIntelligenceConfiguration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getIntelligenceConfiguration
default CompletableFuture<GetIntelligenceConfigurationResponse> getIntelligenceConfiguration(Consumer<GetIntelligenceConfigurationRequest.Builder> getIntelligenceConfigurationRequest) Retrieves the intelligence configuration for the calling account. Account is identified via FAS (caller identity). Returns the default configuration if none exists yet.
This is a convenience which creates an instance of the
GetIntelligenceConfigurationRequest.Builderavoiding the need to create one manually viaGetIntelligenceConfigurationRequest.builder()- Parameters:
getIntelligenceConfigurationRequest- AConsumerthat will call methods onGetIntelligenceConfigurationRequest.Builderto create a request. The request for retrieving the intelligence configuration of the calling account.- Returns:
- A Java Future containing the result of the GetIntelligenceConfiguration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOmniDashboard
default CompletableFuture<GetOmniDashboardResponse> getOmniDashboard(GetOmniDashboardRequest getOmniDashboardRequest) Retrieves a dashboard by ID within a space.
- Parameters:
getOmniDashboardRequest-- Returns:
- A Java Future containing the result of the GetOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOmniDashboard
default CompletableFuture<GetOmniDashboardResponse> getOmniDashboard(Consumer<GetOmniDashboardRequest.Builder> getOmniDashboardRequest) Retrieves a dashboard by ID within a space.
This is a convenience which creates an instance of the
GetOmniDashboardRequest.Builderavoiding the need to create one manually viaGetOmniDashboardRequest.builder()- Parameters:
getOmniDashboardRequest- AConsumerthat will call methods onGetOmniDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpace
Retrieves the details of a space by ID.
- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException 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) Retrieves the details of a space by ID.
This is a convenience which creates an instance of the
GetSpaceRequest.Builderavoiding the need to create one manually viaGetSpaceRequest.builder()- Parameters:
getSpaceRequest- AConsumerthat will call methods onGetSpaceRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpaceCredentialsForOrganization
default CompletableFuture<GetSpaceCredentialsForOrganizationResponse> getSpaceCredentialsForOrganization(GetSpaceCredentialsForOrganizationRequest getSpaceCredentialsForOrganizationRequest) Returns temporary credentials for a space in an organization member account. The credentials are valid for one hour.
The caller must be the organization's management account or a delegated administrator with access to the target space. The target account must be an active member of the same organization as the domain, and the space must already exist.
- Parameters:
getSpaceCredentialsForOrganizationRequest-- Returns:
- A Java Future containing the result of the GetSpaceCredentialsForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSpaceCredentialsForOrganization
default CompletableFuture<GetSpaceCredentialsForOrganizationResponse> getSpaceCredentialsForOrganization(Consumer<GetSpaceCredentialsForOrganizationRequest.Builder> getSpaceCredentialsForOrganizationRequest) Returns temporary credentials for a space in an organization member account. The credentials are valid for one hour.
The caller must be the organization's management account or a delegated administrator with access to the target space. The target account must be an active member of the same organization as the domain, and the space must already exist.
This is a convenience which creates an instance of the
GetSpaceCredentialsForOrganizationRequest.Builderavoiding the need to create one manually viaGetSpaceCredentialsForOrganizationRequest.builder()- Parameters:
getSpaceCredentialsForOrganizationRequest- AConsumerthat will call methods onGetSpaceCredentialsForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetSpaceCredentialsForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryQueryResults
default CompletableFuture<GetTelemetryQueryResultsResponse> getTelemetryQueryResults(GetTelemetryQueryResultsRequest getTelemetryQueryResultsRequest) Returns the results for the specified query.
- Parameters:
getTelemetryQueryResultsRequest-- Returns:
- A Java Future containing the result of the GetTelemetryQueryResults 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryQueryResults
default CompletableFuture<GetTelemetryQueryResultsResponse> getTelemetryQueryResults(Consumer<GetTelemetryQueryResultsRequest.Builder> getTelemetryQueryResultsRequest) Returns the results for the specified query.
This is a convenience which creates an instance of the
GetTelemetryQueryResultsRequest.Builderavoiding the need to create one manually viaGetTelemetryQueryResultsRequest.builder()- Parameters:
getTelemetryQueryResultsRequest- AConsumerthat will call methods onGetTelemetryQueryResultsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTelemetryQueryResults 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryQueryResultsPaginator
default GetTelemetryQueryResultsPublisher getTelemetryQueryResultsPaginator(GetTelemetryQueryResultsRequest getTelemetryQueryResultsRequest) This is a variant of
getTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.GetTelemetryQueryResultsPublisher publisher = client.getTelemetryQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.GetTelemetryQueryResultsPublisher publisher = client.getTelemetryQueryResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsResponse 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
getTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)operation.- Parameters:
getTelemetryQueryResultsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTelemetryQueryResultsPaginator
default GetTelemetryQueryResultsPublisher getTelemetryQueryResultsPaginator(Consumer<GetTelemetryQueryResultsRequest.Builder> getTelemetryQueryResultsRequest) This is a variant of
getTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.GetTelemetryQueryResultsPublisher publisher = client.getTelemetryQueryResultsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.GetTelemetryQueryResultsPublisher publisher = client.getTelemetryQueryResultsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsResponse 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
getTelemetryQueryResults(software.amazon.awssdk.services.cloudwatchomni.model.GetTelemetryQueryResultsRequest)operation.
This is a convenience which creates an instance of the
GetTelemetryQueryResultsRequest.Builderavoiding the need to create one manually viaGetTelemetryQueryResultsRequest.builder()- Parameters:
getTelemetryQueryResultsRequest- AConsumerthat will call methods onGetTelemetryQueryResultsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getView
Returns the definition and metadata of the specified view.
- Parameters:
getViewRequest-- Returns:
- A Java Future containing the result of the GetView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getView
Returns the definition and metadata of the specified view.
This is a convenience which creates an instance of the
GetViewRequest.Builderavoiding the need to create one manually viaGetViewRequest.builder()- Parameters:
getViewRequest- AConsumerthat will call methods onGetViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessGrants
default CompletableFuture<ListAccessGrantsResponse> listAccessGrants(ListAccessGrantsRequest listAccessGrantsRequest) Returns AccessGrants, with optional filtering by domain, space, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the current account and Region.
- Parameters:
listAccessGrantsRequest-- Returns:
- A Java Future containing the result of the ListAccessGrants 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessGrants
default CompletableFuture<ListAccessGrantsResponse> listAccessGrants(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) Returns AccessGrants, with optional filtering by domain, space, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the current account and Region.
This is a convenience which creates an instance of the
ListAccessGrantsRequest.Builderavoiding the need to create one manually viaListAccessGrantsRequest.builder()- Parameters:
listAccessGrantsRequest- AConsumerthat will call methods onListAccessGrantsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAccessGrants 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessGrantsPaginator
default ListAccessGrantsPublisher listAccessGrantsPaginator(ListAccessGrantsRequest listAccessGrantsRequest) This is a variant of
listAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsResponse 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
listAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)operation.- Parameters:
listAccessGrantsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessGrantsPaginator
default ListAccessGrantsPublisher listAccessGrantsPaginator(Consumer<ListAccessGrantsRequest.Builder> listAccessGrantsRequest) This is a variant of
listAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessGrantsPublisher publisher = client.listAccessGrantsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsResponse 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
listAccessGrants(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessGrantsRequest)operation.
This is a convenience which creates an instance of the
ListAccessGrantsRequest.Builderavoiding the need to create one manually viaListAccessGrantsRequest.builder()- Parameters:
listAccessGrantsRequest- AConsumerthat will call methods onListAccessGrantsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessProfiles
default CompletableFuture<ListAccessProfilesResponse> listAccessProfiles(ListAccessProfilesRequest listAccessProfilesRequest) Returns the access profiles in a space.
- Parameters:
listAccessProfilesRequest-- Returns:
- A Java Future containing the result of the ListAccessProfiles 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessProfiles
default CompletableFuture<ListAccessProfilesResponse> listAccessProfiles(Consumer<ListAccessProfilesRequest.Builder> listAccessProfilesRequest) Returns the access profiles in a space.
This is a convenience which creates an instance of the
ListAccessProfilesRequest.Builderavoiding the need to create one manually viaListAccessProfilesRequest.builder()- Parameters:
listAccessProfilesRequest- AConsumerthat will call methods onListAccessProfilesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAccessProfiles 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessProfilesPaginator
default ListAccessProfilesPublisher listAccessProfilesPaginator(ListAccessProfilesRequest listAccessProfilesRequest) This is a variant of
listAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessProfilesPublisher publisher = client.listAccessProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessProfilesPublisher publisher = client.listAccessProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesResponse 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
listAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)operation.- Parameters:
listAccessProfilesRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAccessProfilesPaginator
default ListAccessProfilesPublisher listAccessProfilesPaginator(Consumer<ListAccessProfilesRequest.Builder> listAccessProfilesRequest) This is a variant of
listAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessProfilesPublisher publisher = client.listAccessProfilesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAccessProfilesPublisher publisher = client.listAccessProfilesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesResponse 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
listAccessProfiles(software.amazon.awssdk.services.cloudwatchomni.model.ListAccessProfilesRequest)operation.
This is a convenience which creates an instance of the
ListAccessProfilesRequest.Builderavoiding the need to create one manually viaListAccessProfilesRequest.builder()- Parameters:
listAccessProfilesRequest- AConsumerthat will call methods onListAccessProfilesRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlerts
Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.
Use GetAlert to retrieve a single alert's full detail.
- Parameters:
listAlertsRequest-- Returns:
- A Java Future containing the result of the ListAlerts 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlerts
default CompletableFuture<ListAlertsResponse> listAlerts(Consumer<ListAlertsRequest.Builder> listAlertsRequest) Lists alerts within a space, optionally filtered by exact name(s), a single name prefix, or exact alertId(s), with pagination.
Use GetAlert to retrieve a single alert's full detail.
This is a convenience which creates an instance of the
ListAlertsRequest.Builderavoiding the need to create one manually viaListAlertsRequest.builder()- Parameters:
listAlertsRequest- AConsumerthat will call methods onListAlertsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListAlerts 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlertsPaginator
This is a variant of
listAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsResponse 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
listAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)operation.- Parameters:
listAlertsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listAlertsPaginator
default ListAlertsPublisher listAlertsPaginator(Consumer<ListAlertsRequest.Builder> listAlertsRequest) This is a variant of
listAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListAlertsPublisher publisher = client.listAlertsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsResponse 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
listAlerts(software.amazon.awssdk.services.cloudwatchomni.model.ListAlertsRequest)operation.
This is a convenience which creates an instance of the
ListAlertsRequest.Builderavoiding the need to create one manually viaListAlertsRequest.builder()- Parameters:
listAlertsRequest- AConsumerthat will call methods onListAlertsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAccessGrantsForOrganization
default CompletableFuture<ListDomainAccessGrantsForOrganizationResponse> listDomainAccessGrantsForOrganization(ListDomainAccessGrantsForOrganizationRequest listDomainAccessGrantsForOrganizationRequest) Returns organization-level domain access grants, with optional filtering by domain, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the caller's organization.
- Parameters:
listDomainAccessGrantsForOrganizationRequest-- Returns:
- A Java Future containing the result of the ListDomainAccessGrantsForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAccessGrantsForOrganization
default CompletableFuture<ListDomainAccessGrantsForOrganizationResponse> listDomainAccessGrantsForOrganization(Consumer<ListDomainAccessGrantsForOrganizationRequest.Builder> listDomainAccessGrantsForOrganizationRequest) Returns organization-level domain access grants, with optional filtering by domain, principal, or permission. A grant is returned only when it matches every filter supplied. With no filters, returns the grants for the caller's organization.
This is a convenience which creates an instance of the
ListDomainAccessGrantsForOrganizationRequest.Builderavoiding the need to create one manually viaListDomainAccessGrantsForOrganizationRequest.builder()- Parameters:
listDomainAccessGrantsForOrganizationRequest- AConsumerthat will call methods onListDomainAccessGrantsForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDomainAccessGrantsForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAccessGrantsForOrganizationPaginator
default ListDomainAccessGrantsForOrganizationPublisher listDomainAccessGrantsForOrganizationPaginator(ListDomainAccessGrantsForOrganizationRequest listDomainAccessGrantsForOrganizationRequest) This is a variant of
listDomainAccessGrantsForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainAccessGrantsForOrganizationPublisher publisher = client.listDomainAccessGrantsForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainAccessGrantsForOrganizationPublisher publisher = client.listDomainAccessGrantsForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationResponse 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
listDomainAccessGrantsForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationRequest)operation.- Parameters:
listDomainAccessGrantsForOrganizationRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainAccessGrantsForOrganizationPaginator
default ListDomainAccessGrantsForOrganizationPublisher listDomainAccessGrantsForOrganizationPaginator(Consumer<ListDomainAccessGrantsForOrganizationRequest.Builder> listDomainAccessGrantsForOrganizationRequest) This is a variant of
listDomainAccessGrantsForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainAccessGrantsForOrganizationPublisher publisher = client.listDomainAccessGrantsForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainAccessGrantsForOrganizationPublisher publisher = client.listDomainAccessGrantsForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationResponse 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
listDomainAccessGrantsForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainAccessGrantsForOrganizationRequest)operation.
This is a convenience which creates an instance of the
ListDomainAccessGrantsForOrganizationRequest.Builderavoiding the need to create one manually viaListDomainAccessGrantsForOrganizationRequest.builder()- Parameters:
listDomainAccessGrantsForOrganizationRequest- AConsumerthat will call methods onListDomainAccessGrantsForOrganizationRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists. At most two domains are returned.
- Parameters:
listDomainsRequest-- Returns:
- A Java Future containing the result of the ListDomains 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomains
default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Returns the caller's domains: the account-scoped domain and the organization-scoped domain, if either exists. At most two domains are returned.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDomains 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
This is a variant of
listDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsResponse 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
listDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)operation.- Parameters:
listDomainsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDomainsPaginator
default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant of
listDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsResponse 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
listDomains(software.amazon.awssdk.services.cloudwatchomni.model.ListDomainsRequest)operation.
This is a convenience which creates an instance of the
ListDomainsRequest.Builderavoiding the need to create one manually viaListDomainsRequest.builder()- Parameters:
listDomainsRequest- AConsumerthat will call methods onListDomainsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIntegrations
default CompletableFuture<ListIntegrationsResponse> listIntegrations(ListIntegrationsRequest listIntegrationsRequest) Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.
- Parameters:
listIntegrationsRequest- The request for listing the integrations in an account.- Returns:
- A Java Future containing the result of the ListIntegrations 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIntegrations
default CompletableFuture<ListIntegrationsResponse> listIntegrations(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) Lists the integrations in the account, optionally filtered by type, status, or name. Results are paginated.
This is a convenience which creates an instance of the
ListIntegrationsRequest.Builderavoiding the need to create one manually viaListIntegrationsRequest.builder()- Parameters:
listIntegrationsRequest- AConsumerthat will call methods onListIntegrationsRequest.Builderto create a request. The request for listing the integrations in an account.- Returns:
- A Java Future containing the result of the ListIntegrations 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIntegrationsPaginator
default ListIntegrationsPublisher listIntegrationsPaginator(ListIntegrationsRequest listIntegrationsRequest) This is a variant of
listIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListIntegrationsPublisher publisher = client.listIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListIntegrationsPublisher publisher = client.listIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsResponse 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
listIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)operation.- Parameters:
listIntegrationsRequest- The request for listing the integrations in an account.- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listIntegrationsPaginator
default ListIntegrationsPublisher listIntegrationsPaginator(Consumer<ListIntegrationsRequest.Builder> listIntegrationsRequest) This is a variant of
listIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListIntegrationsPublisher publisher = client.listIntegrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListIntegrationsPublisher publisher = client.listIntegrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsResponse 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
listIntegrations(software.amazon.awssdk.services.cloudwatchomni.model.ListIntegrationsRequest)operation.
This is a convenience which creates an instance of the
ListIntegrationsRequest.Builderavoiding the need to create one manually viaListIntegrationsRequest.builder()- Parameters:
listIntegrationsRequest- AConsumerthat will call methods onListIntegrationsRequest.Builderto create a request. The request for listing the integrations in an account.- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOmniDashboards
default CompletableFuture<ListOmniDashboardsResponse> listOmniDashboards(ListOmniDashboardsRequest listOmniDashboardsRequest) Returns the dashboards in a space, optionally filtered by name prefix.
- Parameters:
listOmniDashboardsRequest-- Returns:
- A Java Future containing the result of the ListOmniDashboards 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOmniDashboards
default CompletableFuture<ListOmniDashboardsResponse> listOmniDashboards(Consumer<ListOmniDashboardsRequest.Builder> listOmniDashboardsRequest) Returns the dashboards in a space, optionally filtered by name prefix.
This is a convenience which creates an instance of the
ListOmniDashboardsRequest.Builderavoiding the need to create one manually viaListOmniDashboardsRequest.builder()- Parameters:
listOmniDashboardsRequest- AConsumerthat will call methods onListOmniDashboardsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListOmniDashboards 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOmniDashboardsPaginator
default ListOmniDashboardsPublisher listOmniDashboardsPaginator(ListOmniDashboardsRequest listOmniDashboardsRequest) This is a variant of
listOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListOmniDashboardsPublisher publisher = client.listOmniDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListOmniDashboardsPublisher publisher = client.listOmniDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsResponse 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
listOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)operation.- Parameters:
listOmniDashboardsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listOmniDashboardsPaginator
default ListOmniDashboardsPublisher listOmniDashboardsPaginator(Consumer<ListOmniDashboardsRequest.Builder> listOmniDashboardsRequest) This is a variant of
listOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListOmniDashboardsPublisher publisher = client.listOmniDashboardsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListOmniDashboardsPublisher publisher = client.listOmniDashboardsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsResponse 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
listOmniDashboards(software.amazon.awssdk.services.cloudwatchomni.model.ListOmniDashboardsRequest)operation.
This is a convenience which creates an instance of the
ListOmniDashboardsRequest.Builderavoiding the need to create one manually viaListOmniDashboardsRequest.builder()- Parameters:
listOmniDashboardsRequest- AConsumerthat will call methods onListOmniDashboardsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpaces
Returns the spaces in the account, optionally filtered by domain.
- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException 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) Returns the spaces in the account, optionally filtered by domain.
This is a convenience which creates an instance of the
ListSpacesRequest.Builderavoiding the need to create one manually viaListSpacesRequest.builder()- Parameters:
listSpacesRequest- AConsumerthat will call methods onListSpacesRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesForOrganization
default CompletableFuture<ListSpacesForOrganizationResponse> listSpacesForOrganization(ListSpacesForOrganizationRequest listSpacesForOrganizationRequest) Returns the spaces across all member accounts in the organization.
- Parameters:
listSpacesForOrganizationRequest-- Returns:
- A Java Future containing the result of the ListSpacesForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesForOrganization
default CompletableFuture<ListSpacesForOrganizationResponse> listSpacesForOrganization(Consumer<ListSpacesForOrganizationRequest.Builder> listSpacesForOrganizationRequest) Returns the spaces across all member accounts in the organization.
This is a convenience which creates an instance of the
ListSpacesForOrganizationRequest.Builderavoiding the need to create one manually viaListSpacesForOrganizationRequest.builder()- Parameters:
listSpacesForOrganizationRequest- AConsumerthat will call methods onListSpacesForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListSpacesForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesForOrganizationPaginator
default ListSpacesForOrganizationPublisher listSpacesForOrganizationPaginator(ListSpacesForOrganizationRequest listSpacesForOrganizationRequest) This is a variant of
listSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesForOrganizationPublisher publisher = client.listSpacesForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesForOrganizationPublisher publisher = client.listSpacesForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationResponse 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
listSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)operation.- Parameters:
listSpacesForOrganizationRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listSpacesForOrganizationPaginator
default ListSpacesForOrganizationPublisher listSpacesForOrganizationPaginator(Consumer<ListSpacesForOrganizationRequest.Builder> listSpacesForOrganizationRequest) This is a variant of
listSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesForOrganizationPublisher publisher = client.listSpacesForOrganizationPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesForOrganizationPublisher publisher = client.listSpacesForOrganizationPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationResponse 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
listSpacesForOrganization(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesForOrganizationRequest)operation.
This is a convenience which creates an instance of the
ListSpacesForOrganizationRequest.Builderavoiding the need to create one manually viaListSpacesForOrganizationRequest.builder()- Parameters:
listSpacesForOrganizationRequest- AConsumerthat will call methods onListSpacesForOrganizationRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException 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.cloudwatchomni.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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesResponse 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
listSpaces(software.amazon.awssdk.services.cloudwatchomni.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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException 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.cloudwatchomni.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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListSpacesPublisher publisher = client.listSpacesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesResponse 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
listSpaces(software.amazon.awssdk.services.cloudwatchomni.model.ListSpacesRequest)operation.
This is a convenience which creates an instance of the
ListSpacesRequest.Builderavoiding the need to create one manually viaListSpacesRequest.builder()- Parameters:
listSpacesRequest- AConsumerthat will call methods onListSpacesRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryFields
default CompletableFuture<ListTelemetryFieldsResponse> listTelemetryFields(ListTelemetryFieldsRequest listTelemetryFieldsRequest) Lists fields available for telemetry queries.
Returns a list of fields included in the specified dataset, granular to telemetry type. Returned field names reflect the exact stored casing and are case-sensitive when referenced in query expressions; the query engine does not normalize identifier case.
- Parameters:
listTelemetryFieldsRequest-- Returns:
- A Java Future containing the result of the ListTelemetryFields 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryFields
default CompletableFuture<ListTelemetryFieldsResponse> listTelemetryFields(Consumer<ListTelemetryFieldsRequest.Builder> listTelemetryFieldsRequest) Lists fields available for telemetry queries.
Returns a list of fields included in the specified dataset, granular to telemetry type. Returned field names reflect the exact stored casing and are case-sensitive when referenced in query expressions; the query engine does not normalize identifier case.
This is a convenience which creates an instance of the
ListTelemetryFieldsRequest.Builderavoiding the need to create one manually viaListTelemetryFieldsRequest.builder()- Parameters:
listTelemetryFieldsRequest- AConsumerthat will call methods onListTelemetryFieldsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTelemetryFields 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryFieldsPaginator
default ListTelemetryFieldsPublisher listTelemetryFieldsPaginator(ListTelemetryFieldsRequest listTelemetryFieldsRequest) This is a variant of
listTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryFieldsPublisher publisher = client.listTelemetryFieldsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryFieldsPublisher publisher = client.listTelemetryFieldsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsResponse 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
listTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)operation.- Parameters:
listTelemetryFieldsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryFieldsPaginator
default ListTelemetryFieldsPublisher listTelemetryFieldsPaginator(Consumer<ListTelemetryFieldsRequest.Builder> listTelemetryFieldsRequest) This is a variant of
listTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryFieldsPublisher publisher = client.listTelemetryFieldsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryFieldsPublisher publisher = client.listTelemetryFieldsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsResponse 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
listTelemetryFields(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryFieldsRequest)operation.
This is a convenience which creates an instance of the
ListTelemetryFieldsRequest.Builderavoiding the need to create one manually viaListTelemetryFieldsRequest.builder()- Parameters:
listTelemetryFieldsRequest- AConsumerthat will call methods onListTelemetryFieldsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryQuerySessions
default CompletableFuture<ListTelemetryQuerySessionsResponse> listTelemetryQuerySessions(ListTelemetryQuerySessionsRequest listTelemetryQuerySessionsRequest) Lists telemetry query sessions.
Returns a list of telemetry query sessions owned by the caller.
- Parameters:
listTelemetryQuerySessionsRequest-- Returns:
- A Java Future containing the result of the ListTelemetryQuerySessions 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryQuerySessions
default CompletableFuture<ListTelemetryQuerySessionsResponse> listTelemetryQuerySessions(Consumer<ListTelemetryQuerySessionsRequest.Builder> listTelemetryQuerySessionsRequest) Lists telemetry query sessions.
Returns a list of telemetry query sessions owned by the caller.
This is a convenience which creates an instance of the
ListTelemetryQuerySessionsRequest.Builderavoiding the need to create one manually viaListTelemetryQuerySessionsRequest.builder()- Parameters:
listTelemetryQuerySessionsRequest- AConsumerthat will call methods onListTelemetryQuerySessionsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTelemetryQuerySessions 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryQuerySessionsPaginator
default ListTelemetryQuerySessionsPublisher listTelemetryQuerySessionsPaginator(ListTelemetryQuerySessionsRequest listTelemetryQuerySessionsRequest) This is a variant of
listTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryQuerySessionsPublisher publisher = client.listTelemetryQuerySessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryQuerySessionsPublisher publisher = client.listTelemetryQuerySessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsResponse 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
listTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)operation.- Parameters:
listTelemetryQuerySessionsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTelemetryQuerySessionsPaginator
default ListTelemetryQuerySessionsPublisher listTelemetryQuerySessionsPaginator(Consumer<ListTelemetryQuerySessionsRequest.Builder> listTelemetryQuerySessionsRequest) This is a variant of
listTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryQuerySessionsPublisher publisher = client.listTelemetryQuerySessionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListTelemetryQuerySessionsPublisher publisher = client.listTelemetryQuerySessionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsResponse 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
listTelemetryQuerySessions(software.amazon.awssdk.services.cloudwatchomni.model.ListTelemetryQuerySessionsRequest)operation.
This is a convenience which creates an instance of the
ListTelemetryQuerySessionsRequest.Builderavoiding the need to create one manually viaListTelemetryQuerySessionsRequest.builder()- Parameters:
listTelemetryQuerySessionsRequest- AConsumerthat will call methods onListTelemetryQuerySessionsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViews
Lists the views in the caller's account and region.
Returns a summary for each view, optionally filtered by view type. View definitions are not included — use GetView to retrieve them.
- Parameters:
listViewsRequest-- Returns:
- A Java Future containing the result of the ListViews 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViews
default CompletableFuture<ListViewsResponse> listViews(Consumer<ListViewsRequest.Builder> listViewsRequest) Lists the views in the caller's account and region.
Returns a summary for each view, optionally filtered by view type. View definitions are not included — use GetView to retrieve them.
This is a convenience which creates an instance of the
ListViewsRequest.Builderavoiding the need to create one manually viaListViewsRequest.builder()- Parameters:
listViewsRequest- AConsumerthat will call methods onListViewsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListViews 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViewsPaginator
This is a variant of
listViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsResponse 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
listViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)operation.- Parameters:
listViewsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listViewsPaginator
This is a variant of
listViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.ListViewsPublisher publisher = client.listViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.ListViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsResponse 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
listViews(software.amazon.awssdk.services.cloudwatchomni.model.ListViewsRequest)operation.
This is a convenience which creates an instance of the
ListViewsRequest.Builderavoiding the need to create one manually viaListViewsRequest.builder()- Parameters:
listViewsRequest- AConsumerthat will call methods onListViewsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putIntelligenceConfiguration
default CompletableFuture<PutIntelligenceConfigurationResponse> putIntelligenceConfiguration(PutIntelligenceConfigurationRequest putIntelligenceConfigurationRequest) Creates or updates the intelligence configuration for the calling account. Account is identified via FAS (caller identity).
- Parameters:
putIntelligenceConfigurationRequest- The request for updating the intelligence configuration of the calling account.- Returns:
- A Java Future containing the result of the PutIntelligenceConfiguration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putIntelligenceConfiguration
default CompletableFuture<PutIntelligenceConfigurationResponse> putIntelligenceConfiguration(Consumer<PutIntelligenceConfigurationRequest.Builder> putIntelligenceConfigurationRequest) Creates or updates the intelligence configuration for the calling account. Account is identified via FAS (caller identity).
This is a convenience which creates an instance of the
PutIntelligenceConfigurationRequest.Builderavoiding the need to create one manually viaPutIntelligenceConfigurationRequest.builder()- Parameters:
putIntelligenceConfigurationRequest- AConsumerthat will call methods onPutIntelligenceConfigurationRequest.Builderto create a request. The request for updating the intelligence configuration of the calling account.- Returns:
- A Java Future containing the result of the PutIntelligenceConfiguration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPrincipals
default CompletableFuture<SearchPrincipalsResponse> searchPrincipals(SearchPrincipalsRequest searchPrincipalsRequest) Searches Identity Center for users and groups in a domain. The domain must be configured with Identity Center.
To grant access to a result, pass its principalId to CreateAccessGrant with a principalType of IDC_USER for a user or IDC_GROUP for a group.
- Parameters:
searchPrincipalsRequest-- Returns:
- A Java Future containing the result of the SearchPrincipals 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPrincipals
default CompletableFuture<SearchPrincipalsResponse> searchPrincipals(Consumer<SearchPrincipalsRequest.Builder> searchPrincipalsRequest) Searches Identity Center for users and groups in a domain. The domain must be configured with Identity Center.
To grant access to a result, pass its principalId to CreateAccessGrant with a principalType of IDC_USER for a user or IDC_GROUP for a group.
This is a convenience which creates an instance of the
SearchPrincipalsRequest.Builderavoiding the need to create one manually viaSearchPrincipalsRequest.builder()- Parameters:
searchPrincipalsRequest- AConsumerthat will call methods onSearchPrincipalsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the SearchPrincipals 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPrincipalsPaginator
default SearchPrincipalsPublisher searchPrincipalsPaginator(SearchPrincipalsRequest searchPrincipalsRequest) This is a variant of
searchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.SearchPrincipalsPublisher publisher = client.searchPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.SearchPrincipalsPublisher publisher = client.searchPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsResponse 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
searchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)operation.- Parameters:
searchPrincipalsRequest-- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
searchPrincipalsPaginator
default SearchPrincipalsPublisher searchPrincipalsPaginator(Consumer<SearchPrincipalsRequest.Builder> searchPrincipalsRequest) This is a variant of
searchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)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 newSubscriptioni.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 method
2) Using a custom subscribersoftware.amazon.awssdk.services.cloudwatchomni.paginators.SearchPrincipalsPublisher publisher = client.searchPrincipalsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.cloudwatchomni.paginators.SearchPrincipalsPublisher publisher = client.searchPrincipalsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsResponse 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
searchPrincipals(software.amazon.awssdk.services.cloudwatchomni.model.SearchPrincipalsRequest)operation.
This is a convenience which creates an instance of the
SearchPrincipalsRequest.Builderavoiding the need to create one manually viaSearchPrincipalsRequest.builder()- Parameters:
searchPrincipalsRequest- AConsumerthat will call methods onSearchPrincipalsRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryQuery
default CompletableFuture<StartTelemetryQueryResponse> startTelemetryQuery(StartTelemetryQueryRequest startTelemetryQueryRequest) Starts a telemetry query within a session.
Submits the provided query string for execution in the specified session. Use GetTelemetryQueryResults to poll for results and check query status.
- Parameters:
startTelemetryQueryRequest-- Returns:
- A Java Future containing the result of the StartTelemetryQuery 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryQuery
default CompletableFuture<StartTelemetryQueryResponse> startTelemetryQuery(Consumer<StartTelemetryQueryRequest.Builder> startTelemetryQueryRequest) Starts a telemetry query within a session.
Submits the provided query string for execution in the specified session. Use GetTelemetryQueryResults to poll for results and check query status.
This is a convenience which creates an instance of the
StartTelemetryQueryRequest.Builderavoiding the need to create one manually viaStartTelemetryQueryRequest.builder()- Parameters:
startTelemetryQueryRequest- AConsumerthat will call methods onStartTelemetryQueryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartTelemetryQuery 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryQuerySession
default CompletableFuture<StartTelemetryQuerySessionResponse> startTelemetryQuerySession(StartTelemetryQuerySessionRequest startTelemetryQuerySessionRequest) Starts a new telemetry query session.
A session provides a logical grouping for one or more telemetry queries. The returned session ID is required when starting queries via StartTelemetryQuery.
- Parameters:
startTelemetryQuerySessionRequest-- Returns:
- A Java Future containing the result of the StartTelemetryQuerySession 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startTelemetryQuerySession
default CompletableFuture<StartTelemetryQuerySessionResponse> startTelemetryQuerySession(Consumer<StartTelemetryQuerySessionRequest.Builder> startTelemetryQuerySessionRequest) Starts a new telemetry query session.
A session provides a logical grouping for one or more telemetry queries. The returned session ID is required when starting queries via StartTelemetryQuery.
This is a convenience which creates an instance of the
StartTelemetryQuerySessionRequest.Builderavoiding the need to create one manually viaStartTelemetryQuerySessionRequest.builder()- Parameters:
startTelemetryQuerySessionRequest- AConsumerthat will call methods onStartTelemetryQuerySessionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StartTelemetryQuerySession 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryQuery
default CompletableFuture<StopTelemetryQueryResponse> stopTelemetryQuery(StopTelemetryQueryRequest stopTelemetryQueryRequest) Stops a running telemetry query.
- Parameters:
stopTelemetryQueryRequest-- Returns:
- A Java Future containing the result of the StopTelemetryQuery 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryQuery
default CompletableFuture<StopTelemetryQueryResponse> stopTelemetryQuery(Consumer<StopTelemetryQueryRequest.Builder> stopTelemetryQueryRequest) Stops a running telemetry query.
This is a convenience which creates an instance of the
StopTelemetryQueryRequest.Builderavoiding the need to create one manually viaStopTelemetryQueryRequest.builder()- Parameters:
stopTelemetryQueryRequest- AConsumerthat will call methods onStopTelemetryQueryRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StopTelemetryQuery 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryQuerySession
default CompletableFuture<StopTelemetryQuerySessionResponse> stopTelemetryQuerySession(StopTelemetryQuerySessionRequest stopTelemetryQuerySessionRequest) Stops a telemetry query session.
Terminates the specified session. After a session is stopped it cannot be reused.
- Parameters:
stopTelemetryQuerySessionRequest-- Returns:
- A Java Future containing the result of the StopTelemetryQuerySession 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopTelemetryQuerySession
default CompletableFuture<StopTelemetryQuerySessionResponse> stopTelemetryQuerySession(Consumer<StopTelemetryQuerySessionRequest.Builder> stopTelemetryQuerySessionRequest) Stops a telemetry query session.
Terminates the specified session. After a session is stopped it cannot be reused.
This is a convenience which creates an instance of the
StopTelemetryQuerySessionRequest.Builderavoiding the need to create one manually viaStopTelemetryQuerySessionRequest.builder()- Parameters:
stopTelemetryQuerySessionRequest- AConsumerthat will call methods onStopTelemetryQuerySessionRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the StopTelemetryQuerySession 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccessProfile
default CompletableFuture<UpdateAccessProfileResponse> updateAccessProfile(UpdateAccessProfileRequest updateAccessProfileRequest) Updates the name or description of an access profile.
Only the provided fields are changed; omitted fields are left unchanged.
- Parameters:
updateAccessProfileRequest-- Returns:
- A Java Future containing the result of the UpdateAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAccessProfile
default CompletableFuture<UpdateAccessProfileResponse> updateAccessProfile(Consumer<UpdateAccessProfileRequest.Builder> updateAccessProfileRequest) Updates the name or description of an access profile.
Only the provided fields are changed; omitted fields are left unchanged.
This is a convenience which creates an instance of the
UpdateAccessProfileRequest.Builderavoiding the need to create one manually viaUpdateAccessProfileRequest.builder()- Parameters:
updateAccessProfileRequest- AConsumerthat will call methods onUpdateAccessProfileRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAccessProfile 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlert
Updates an existing alert.
Only non-null fields overwrite existing values.
- Parameters:
updateAlertRequest-- Returns:
- A Java Future containing the result of the UpdateAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateAlert
default CompletableFuture<UpdateAlertResponse> updateAlert(Consumer<UpdateAlertRequest.Builder> updateAlertRequest) Updates an existing alert.
Only non-null fields overwrite existing values.
This is a convenience which creates an instance of the
UpdateAlertRequest.Builderavoiding the need to create one manually viaUpdateAlertRequest.builder()- Parameters:
updateAlertRequest- AConsumerthat will call methods onUpdateAlertRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateAlert 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomain
default CompletableFuture<UpdateDomainResponse> updateDomain(UpdateDomainRequest updateDomainRequest) Updates a domain's name or identity provider configuration.
Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.
- Parameters:
updateDomainRequest-- Returns:
- A Java Future containing the result of the UpdateDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomain
default CompletableFuture<UpdateDomainResponse> updateDomain(Consumer<UpdateDomainRequest.Builder> updateDomainRequest) Updates a domain's name or identity provider configuration.
Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.
This is a convenience which creates an instance of the
UpdateDomainRequest.Builderavoiding the need to create one manually viaUpdateDomainRequest.builder()- Parameters:
updateDomainRequest- AConsumerthat will call methods onUpdateDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDomain 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomainForOrganization
default CompletableFuture<UpdateDomainForOrganizationResponse> updateDomainForOrganization(UpdateDomainForOrganizationRequest updateDomainForOrganizationRequest) Updates an organization domain's name or identity provider configuration. Call this operation in the Region where the domain was created.
Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.
- Parameters:
updateDomainForOrganizationRequest-- Returns:
- A Java Future containing the result of the UpdateDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDomainForOrganization
default CompletableFuture<UpdateDomainForOrganizationResponse> updateDomainForOrganization(Consumer<UpdateDomainForOrganizationRequest.Builder> updateDomainForOrganizationRequest) Updates an organization domain's name or identity provider configuration. Call this operation in the Region where the domain was created.
Only the provided fields are changed; omitted fields are left unchanged. Renaming a domain also changes the endpoint URLs derived from its name.
This is a convenience which creates an instance of the
UpdateDomainForOrganizationRequest.Builderavoiding the need to create one manually viaUpdateDomainForOrganizationRequest.builder()- Parameters:
updateDomainForOrganizationRequest- AConsumerthat will call methods onUpdateDomainForOrganizationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDomainForOrganization 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIntegration
default CompletableFuture<UpdateIntegrationResponse> updateIntegration(UpdateIntegrationRequest updateIntegrationRequest) Updates an existing integration, identified by its id, ARN, or name. Only the fields you provide are changed.
- Parameters:
updateIntegrationRequest- The request for updating an existing integration.- Returns:
- A Java Future containing the result of the UpdateIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateIntegration
default CompletableFuture<UpdateIntegrationResponse> updateIntegration(Consumer<UpdateIntegrationRequest.Builder> updateIntegrationRequest) Updates an existing integration, identified by its id, ARN, or name. Only the fields you provide are changed.
This is a convenience which creates an instance of the
UpdateIntegrationRequest.Builderavoiding the need to create one manually viaUpdateIntegrationRequest.builder()- Parameters:
updateIntegrationRequest- AConsumerthat will call methods onUpdateIntegrationRequest.Builderto create a request. The request for updating an existing integration.- Returns:
- A Java Future containing the result of the UpdateIntegration 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOmniDashboard
default CompletableFuture<UpdateOmniDashboardResponse> updateOmniDashboard(UpdateOmniDashboardRequest updateOmniDashboardRequest) Updates an existing dashboard within a space.
Only the provided fields are changed; omitted fields are left unchanged.
- Parameters:
updateOmniDashboardRequest-- Returns:
- A Java Future containing the result of the UpdateOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateOmniDashboard
default CompletableFuture<UpdateOmniDashboardResponse> updateOmniDashboard(Consumer<UpdateOmniDashboardRequest.Builder> updateOmniDashboardRequest) Updates an existing dashboard within a space.
Only the provided fields are changed; omitted fields are left unchanged.
This is a convenience which creates an instance of the
UpdateOmniDashboardRequest.Builderavoiding the need to create one manually viaUpdateOmniDashboardRequest.builder()- Parameters:
updateOmniDashboardRequest- AConsumerthat will call methods onUpdateOmniDashboardRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateOmniDashboard 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSpace
Updates a space.
Only the provided fields are changed; omitted fields are left unchanged.
- 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException 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) Updates a space.
Only the provided fields are changed; omitted fields are left unchanged.
This is a convenience which creates an instance of the
UpdateSpaceRequest.Builderavoiding the need to create one manually viaUpdateSpaceRequest.builder()- Parameters:
updateSpaceRequest- AConsumerthat will call methods onUpdateSpaceRequest.Builderto 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- ServiceQuotaExceededException A service quota was exceeded.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateView
Updates an existing view's definition and/or description.
Only the fields you provide are changed. Managed views cannot be updated.
- Parameters:
updateViewRequest-- Returns:
- A Java Future containing the result of the UpdateView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateView
default CompletableFuture<UpdateViewResponse> updateView(Consumer<UpdateViewRequest.Builder> updateViewRequest) Updates an existing view's definition and/or description.
Only the fields you provide are changed. Managed views cannot be updated.
This is a convenience which creates an instance of the
UpdateViewRequest.Builderavoiding the need to create one manually viaUpdateViewRequest.builder()- Parameters:
updateViewRequest- AConsumerthat will call methods onUpdateViewRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateView 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 throttled due to exceeding the allowed request rate.
- ValidationException A parameter is specified incorrectly.
- ResourceNotFoundException The specified resource does not exist.
- AccessDeniedException The caller is not authorized to perform this action.
- InternalServerException An unexpected error occurred while processing the request.
- ConflictException The operation could not be completed because of a conflict with the current state of the resource.
- 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.
- CloudWatchOmniException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aCloudWatchOmniAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aCloudWatchOmniAsyncClient.
-