JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
  • Detail:
  • Field |
  • Constr |
  • Method
com.amazonaws.services.oam

Class AWSOAMAsyncClient

  • All Implemented Interfaces:
    AWSOAM, AWSOAMAsync


    @ThreadSafe
     @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
    public class AWSOAMAsyncClient
    extends AWSOAMClient
    implements AWSOAMAsync 
    Client for accessing CloudWatch Observability Access Manager asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

    Use Amazon CloudWatch Observability Access Manager to create and manage links between source accounts and monitoring accounts by using CloudWatch cross-account observability. With CloudWatch cross-account observability, you can monitor and troubleshoot applications that span multiple accounts within a Region. Seamlessly search, visualize, and analyze your metrics, logs, traces, and Application Insights applications in any of the linked accounts without account boundaries.

    Set up one or more Amazon Web Services accounts as monitoring accounts and link them with multiple source accounts. A monitoring account is a central Amazon Web Services account that can view and interact with observability data generated from source accounts. A source account is an individual Amazon Web Services account that generates observability data for the resources that reside in it. Source accounts share their observability data with the monitoring account. The shared observability data can include metrics in Amazon CloudWatch, logs in Amazon CloudWatch Logs, traces in X-Ray, and applications in Amazon CloudWatch Application Insights.

    • Method Detail

      • getExecutorService

        public ExecutorService getExecutorService()
        Returns the executor service used by this client to execute async requests.
        Returns:
        The executor service used by this client to execute async requests.
      • createLinkAsync

        public Future<CreateLinkResult> createLinkAsync(CreateLinkRequest request)
        Description copied from interface: AWSOAMAsync

        Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

        Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

        For more information, see CreateSink and PutSinkPolicy.

        Each monitoring account can be linked to as many as 100,000 source accounts.

        Each source account can be linked to as many as five monitoring accounts.

        Specified by:
        createLinkAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the CreateLink operation returned by the service.
        See Also:
        AWS API Documentation
      • createLinkAsync

        public Future<CreateLinkResult> createLinkAsync(CreateLinkRequest request,
         AsyncHandler<CreateLinkRequest,CreateLinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

        Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

        For more information, see CreateSink and PutSinkPolicy.

        Each monitoring account can be linked to as many as 100,000 source accounts.

        Each source account can be linked to as many as five monitoring accounts.

        Specified by:
        createLinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateLink operation returned by the service.
        See Also:
        AWS API Documentation
      • createSinkAsync

        public Future<CreateSinkResult> createSinkAsync(CreateSinkRequest request)
        Description copied from interface: AWSOAMAsync

        Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

        After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.

        Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.

        Specified by:
        createSinkAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the CreateSink operation returned by the service.
        See Also:
        AWS API Documentation
      • createSinkAsync

        public Future<CreateSinkResult> createSinkAsync(CreateSinkRequest request,
         AsyncHandler<CreateSinkRequest,CreateSinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

        After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.

        Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.

        Specified by:
        createSinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the CreateSink operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteLinkAsync

        public Future<DeleteLinkResult> deleteLinkAsync(DeleteLinkRequest request,
         AsyncHandler<DeleteLinkRequest,DeleteLinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.

        Specified by:
        deleteLinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteLink operation returned by the service.
        See Also:
        AWS API Documentation
      • deleteSinkAsync

        public Future<DeleteSinkResult> deleteSinkAsync(DeleteSinkRequest request,
         AsyncHandler<DeleteSinkRequest,DeleteSinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Deletes a sink. You must delete all links to a sink before you can delete that sink.

        Specified by:
        deleteSinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the DeleteSink operation returned by the service.
        See Also:
        AWS API Documentation
      • getLinkAsync

        public Future<GetLinkResult> getLinkAsync(GetLinkRequest request,
         AsyncHandler<GetLinkRequest,GetLinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Returns complete information about one link.

        To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

        Specified by:
        getLinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetLink operation returned by the service.
        See Also:
        AWS API Documentation
      • getSinkAsync

        public Future<GetSinkResult> getSinkAsync(GetSinkRequest request,
         AsyncHandler<GetSinkRequest,GetSinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Returns complete information about one monitoring account sink.

        To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

        Specified by:
        getSinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetSink operation returned by the service.
        See Also:
        AWS API Documentation
      • getSinkPolicyAsync

        public Future<GetSinkPolicyResult> getSinkPolicyAsync(GetSinkPolicyRequest request,
         AsyncHandler<GetSinkPolicyRequest,GetSinkPolicyResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.

        Specified by:
        getSinkPolicyAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the GetSinkPolicy operation returned by the service.
        See Also:
        AWS API Documentation
      • listLinksAsync

        public Future<ListLinksResult> listLinksAsync(ListLinksRequest request)
        Description copied from interface: AWSOAMAsync

        Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

        To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

        Specified by:
        listLinksAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the ListLinks operation returned by the service.
        See Also:
        AWS API Documentation
      • listLinksAsync

        public Future<ListLinksResult> listLinksAsync(ListLinksRequest request,
         AsyncHandler<ListLinksRequest,ListLinksResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

        To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

        Specified by:
        listLinksAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListLinks operation returned by the service.
        See Also:
        AWS API Documentation
      • listSinksAsync

        public Future<ListSinksResult> listSinksAsync(ListSinksRequest request,
         AsyncHandler<ListSinksRequest,ListSinksResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Use this operation in a monitoring account to return the list of sinks created in that account.

        Specified by:
        listSinksAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the ListSinks operation returned by the service.
        See Also:
        AWS API Documentation
      • putSinkPolicyAsync

        public Future<PutSinkPolicyResult> putSinkPolicyAsync(PutSinkPolicyRequest request)
        Description copied from interface: AWSOAMAsync

        Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

        You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:

        • Metrics - Specify with AWS::CloudWatch::Metric

        • Log groups - Specify with AWS::Logs::LogGroup

        • Traces - Specify with AWS::XRay::Trace

        • Application Insights - Applications - Specify with AWS::ApplicationInsights::Application

        See the examples in this section to see how to specify permitted source accounts and data types.

        Specified by:
        putSinkPolicyAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the PutSinkPolicy operation returned by the service.
        See Also:
        AWS API Documentation
      • putSinkPolicyAsync

        public Future<PutSinkPolicyResult> putSinkPolicyAsync(PutSinkPolicyRequest request,
         AsyncHandler<PutSinkPolicyRequest,PutSinkPolicyResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

        You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:

        • Metrics - Specify with AWS::CloudWatch::Metric

        • Log groups - Specify with AWS::Logs::LogGroup

        • Traces - Specify with AWS::XRay::Trace

        • Application Insights - Applications - Specify with AWS::ApplicationInsights::Application

        See the examples in this section to see how to specify permitted source accounts and data types.

        Specified by:
        putSinkPolicyAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the PutSinkPolicy operation returned by the service.
        See Also:
        AWS API Documentation
      • tagResourceAsync

        public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
        Description copied from interface: AWSOAMAsync

        Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

        Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

        Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

        You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

        You can associate as many as 50 tags with a resource.

        Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

        Specified by:
        tagResourceAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        See Also:
        AWS API Documentation
      • tagResourceAsync

        public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
         AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

        Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

        Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

        You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

        You can associate as many as 50 tags with a resource.

        Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

        Specified by:
        tagResourceAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the TagResource operation returned by the service.
        See Also:
        AWS API Documentation
      • untagResourceAsync

        public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
        Description copied from interface: AWSOAMAsync

        Removes one or more tags from the specified resource.

        Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.

        Specified by:
        untagResourceAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        See Also:
        AWS API Documentation
      • untagResourceAsync

        public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
         AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Removes one or more tags from the specified resource.

        Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.

        Specified by:
        untagResourceAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UntagResource operation returned by the service.
        See Also:
        AWS API Documentation
      • updateLinkAsync

        public Future<UpdateLinkResult> updateLinkAsync(UpdateLinkRequest request)
        Description copied from interface: AWSOAMAsync

        Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.

        When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

        To update the list of tags associated with the sink, use TagResource.

        Specified by:
        updateLinkAsync in interface AWSOAMAsync
        Returns:
        A Java Future containing the result of the UpdateLink operation returned by the service.
        See Also:
        AWS API Documentation
      • updateLinkAsync

        public Future<UpdateLinkResult> updateLinkAsync(UpdateLinkRequest request,
         AsyncHandler<UpdateLinkRequest,UpdateLinkResult> asyncHandler)
        Description copied from interface: AWSOAMAsync

        Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.

        When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

        To update the list of tags associated with the sink, use TagResource.

        Specified by:
        updateLinkAsync in interface AWSOAMAsync
        asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.
        Returns:
        A Java Future containing the result of the UpdateLink operation returned by the service.
        See Also:
        AWS API Documentation
      • shutdown

        public void shutdown()
        Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.
        Specified by:
        shutdown in interface AWSOAM
        Overrides:
        shutdown in class AWSOAMClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

AltStyle によって変換されたページ (->オリジナル) /