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.eventbridge

Class AmazonEventBridgeClient

  • All Implemented Interfaces:
    AmazonEventBridge
    Direct Known Subclasses:
    AmazonEventBridgeAsyncClient 

    @ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonEventBridgeClient
extends AmazonWebServiceClient
implements AmazonEventBridge
    Client for accessing Amazon EventBridge. All service calls made using this client are blocking, and will not return until the service call completes.

    Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

    • Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

    • Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.

    • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

    For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

    • Method Detail

      • createArchive

        public CreateArchiveResult createArchive(CreateArchiveRequest request)

        Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

        Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

        • You call CreateArchive on an event bus set to use a customer managed key for encryption.

        • You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

        • You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

        To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

        Specified by:
        createArchive in interface AmazonEventBridge
        Parameters:
        createArchiveRequest -
        Returns:
        Result of the CreateArchive operation returned by the service.
        Throws:
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ResourceAlreadyExistsException - The resource you are trying to create already exists.
        ResourceNotFoundException - An entity that you specified does not exist.
        InternalException - This exception occurs due to unexpected causes.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        InvalidEventPatternException - The event pattern is not valid.
        See Also:
        AWS API Documentation

      • createEndpoint

        public CreateEndpointResult createEndpoint(CreateEndpointRequest request)

        Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

        Specified by:
        createEndpoint in interface AmazonEventBridge
        Parameters:
        createEndpointRequest -
        Returns:
        Result of the CreateEndpoint operation returned by the service.
        Throws:
        ResourceAlreadyExistsException - The resource you are trying to create already exists.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • createPartnerEventSource

        public CreatePartnerEventSourceResult createPartnerEventSource(CreatePartnerEventSourceRequest request)

        Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.

        Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.

        A partner event source creates events based on resources within the SaaS partner's service or application.

        An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.

        Partner event source names follow this format:

        partner_name/event_namespace/event_name

        • partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers.

        • event_namespace is determined by the partner, and is a way for the partner to categorize their events.

        • event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system.

          The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.

        The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.

        Specified by:
        createPartnerEventSource in interface AmazonEventBridge
        Parameters:
        createPartnerEventSourceRequest -
        Returns:
        Result of the CreatePartnerEventSource operation returned by the service.
        Throws:
        ResourceAlreadyExistsException - The resource you are trying to create already exists.
        InternalException - This exception occurs due to unexpected causes.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        OperationDisabledException - The operation you are attempting is not available in this region.
        See Also:
        AWS API Documentation

      • deleteRule

        public DeleteRuleResult deleteRule(DeleteRuleRequest request)

        Deletes the specified rule.

        Before you can delete the rule, you must remove all targets, using RemoveTargets.

        When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

        If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

        Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.

        Specified by:
        deleteRule in interface AmazonEventBridge
        Parameters:
        deleteRuleRequest -
        Returns:
        Result of the DeleteRule operation returned by the service.
        Throws:
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        ResourceNotFoundException - An entity that you specified does not exist.
        See Also:
        AWS API Documentation

      • describeEventBus

        public DescribeEventBusResult describeEventBus(DescribeEventBusRequest request)

        Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

        To enable your account to receive events from other accounts on its default event bus, use PutPermission.

        For more information about partner event buses, see CreateEventBus.

        Specified by:
        describeEventBus in interface AmazonEventBridge
        Parameters:
        describeEventBusRequest -
        Returns:
        Result of the DescribeEventBus operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • describeReplay

        public DescribeReplayResult describeReplay(DescribeReplayRequest request)

        Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

        Specified by:
        describeReplay in interface AmazonEventBridge
        Parameters:
        describeReplayRequest -
        Returns:
        Result of the DescribeReplay operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • disableRule

        public DisableRuleResult disableRule(DisableRuleRequest request)

        Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

        When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

        Specified by:
        disableRule in interface AmazonEventBridge
        Parameters:
        disableRuleRequest -
        Returns:
        Result of the DisableRule operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • enableRule

        public EnableRuleResult enableRule(EnableRuleRequest request)

        Enables the specified rule. If the rule does not exist, the operation fails.

        When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

        Specified by:
        enableRule in interface AmazonEventBridge
        Parameters:
        enableRuleRequest -
        Returns:
        Result of the EnableRule operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • listRules

        public ListRulesResult listRules(ListRulesRequest request)

        Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

        The maximum number of results per page for requests is 100.

        ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

        Specified by:
        listRules in interface AmazonEventBridge
        Parameters:
        listRulesRequest -
        Returns:
        Result of the ListRules operation returned by the service.
        Throws:
        InternalException - This exception occurs due to unexpected causes.
        ResourceNotFoundException - An entity that you specified does not exist.
        See Also:
        AWS API Documentation

      • putEvents

        public PutEventsResult putEvents(PutEventsRequest request)

        Sends custom events to Amazon EventBridge so that they can be matched to rules.

        The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide

        PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.

        PutEvents will only process nested JSON up to 1100 levels deep.

        Specified by:
        putEvents in interface AmazonEventBridge
        Parameters:
        putEventsRequest -
        Returns:
        Result of the PutEvents operation returned by the service.
        Throws:
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • putPermission

        public PutPermissionResult putPermission(PutPermissionRequest request)

        Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

        For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.

        To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization.

        If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

        The permission policy on the event bus cannot exceed 10 KB in size.

        Specified by:
        putPermission in interface AmazonEventBridge
        Parameters:
        putPermissionRequest -
        Returns:
        Result of the PutPermission operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.
        InternalException - This exception occurs due to unexpected causes.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        OperationDisabledException - The operation you are attempting is not available in this region.
        See Also:
        AWS API Documentation

      • putRule

        public PutRuleResult putRule(PutRuleRequest request)

        Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

        A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

        If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.

        When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

        A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

        When you initially create a rule, you can optionally assign one or more tags to the rule. 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 rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

        If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

        Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

        In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

        To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

        An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

        Specified by:
        putRule in interface AmazonEventBridge
        Parameters:
        putRuleRequest -
        Returns:
        Result of the PutRule operation returned by the service.
        Throws:
        InvalidEventPatternException - The event pattern is not valid.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        ResourceNotFoundException - An entity that you specified does not exist.
        See Also:
        AWS API Documentation

      • putTargets

        public PutTargetsResult putTargets(PutTargetsRequest request)

        Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

        Targets are the resources that are invoked when a rule is triggered.

        The maximum number of entries per request is 10.

        Each rule can have up to five (5) targets associated with it at one time.

        For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide .

        Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:

        • Amazon EBS CreateSnapshot API call

        • Amazon EC2 RebootInstances API call

        • Amazon EC2 StopInstances API call

        • Amazon EC2 TerminateInstances API call

        For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

        To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

        • For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.

        • For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets.

        For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .

        If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.

        Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account.

        If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

        If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.

        For more information about enabling cross-account events, see PutPermission.

        Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

        • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

        • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

        • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

        • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

        When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

        When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

        This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

        Specified by:
        putTargets in interface AmazonEventBridge
        Parameters:
        putTargetsRequest -
        Returns:
        Result of the PutTargets operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • removeTargets

        public RemoveTargetsResult removeTargets(RemoveTargetsRequest request)

        Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

        A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

        When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

        This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

        The maximum number of entries per request is 10.

        Specified by:
        removeTargets in interface AmazonEventBridge
        Parameters:
        removeTargetsRequest -
        Returns:
        Result of the RemoveTargets operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • startReplay

        public StartReplayResult startReplay(StartReplayRequest request)

        Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

        Specified by:
        startReplay in interface AmazonEventBridge
        Parameters:
        startReplayRequest -
        Returns:
        Result of the StartReplay operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ResourceAlreadyExistsException - The resource you are trying to create already exists.
        InvalidEventPatternException - The event pattern is not valid.
        LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • tagResource

        public TagResourceResult tagResource(TagResourceRequest request)

        Assigns one or more tags (key-value pairs) to the specified EventBridge resource. 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. In EventBridge, rules and event buses can be tagged.

        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, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, 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.

        Specified by:
        tagResource in interface AmazonEventBridge
        Parameters:
        tagResourceRequest -
        Returns:
        Result of the TagResource operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        InternalException - This exception occurs due to unexpected causes.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        See Also:
        AWS API Documentation

      • testEventPattern

        public TestEventPatternResult testEventPattern(TestEventPatternRequest request)

        Tests whether the specified event pattern matches the provided event.

        Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

        Specified by:
        testEventPattern in interface AmazonEventBridge
        Parameters:
        testEventPatternRequest -
        Returns:
        Result of the TestEventPattern operation returned by the service.
        Throws:
        InvalidEventPatternException - The event pattern is not valid.
        InternalException - This exception occurs due to unexpected causes.
        See Also:
        AWS API Documentation

      • untagResource

        public UntagResourceResult untagResource(UntagResourceRequest request)

        Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.

        Specified by:
        untagResource in interface AmazonEventBridge
        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        ResourceNotFoundException - An entity that you specified does not exist.
        InternalException - This exception occurs due to unexpected causes.
        ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.
        ManagedRuleException - This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.
        See Also:
        AWS API Documentation

      • getCachedResponseMetadata

        public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

        Specified by:
        getCachedResponseMetadata in interface AmazonEventBridge
        Parameters:
        request - The originally executed request
        Returns:
        The response metadata for the specified request, or null if none is available.

      • shutdown

        public void shutdown()
        Description copied from class: AmazonWebServiceClient
        Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
        Specified by:
        shutdown in interface AmazonEventBridge
        Overrides:
        shutdown in class AmazonWebServiceClient
Skip navigation links
  • Detail:
  • Field |
  • Constr |
  • Method

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