Struct aws_sdk_eventbridge::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon EventBridge

Client for invoking operations on Amazon EventBridge. Each operation on Amazon EventBridge is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_eventbridge::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_eventbridge::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_eventbridge::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn activate_event_source(&self) -> ActivateEventSource

Constructs a fluent builder for the ActivateEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the partner event source to activate.
On success, responds with ActivateEventSourceOutput
On failure, responds with SdkError<ActivateEventSourceError>

source

pub fn cancel_replay(&self) -> CancelReplay

Constructs a fluent builder for the CancelReplay operation.

The fluent builder is configurable:
- replay_name(impl Into<String>) / set_replay_name(Option<String>):
 The name of the replay to cancel.
On success, responds with CancelReplayOutput with field(s):
- replay_arn(Option<String>):
 The ARN of the replay to cancel.
- state(Option<ReplayState>):
 The current state of the replay.
- state_reason(Option<String>):
 The reason that the replay is in the current state.
On failure, responds with SdkError<CancelReplayError>

source

pub fn create_api_destination(&self) -> CreateApiDestination

Constructs a fluent builder for the CreateApiDestination operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name for the API destination to create.
- description(impl Into<String>) / set_description(Option<String>):
 A description for the API destination to create.
- connection_arn(impl Into<String>) / set_connection_arn(Option<String>):
 The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.
- invocation_endpoint(impl Into<String>) / set_invocation_endpoint(Option<String>):
 The URL to the HTTP invocation endpoint for the API destination.
- http_method(ApiDestinationHttpMethod) / set_http_method(Option<ApiDestinationHttpMethod>):
 The method to use for the request to the HTTP invocation endpoint.
- invocation_rate_limit_per_second(i32) / set_invocation_rate_limit_per_second(Option<i32>):
 The maximum number of requests per second to send to the HTTP invocation endpoint.
On success, responds with CreateApiDestinationOutput with field(s):
- api_destination_arn(Option<String>):
 The ARN of the API destination that was created by the request.
- api_destination_state(Option<ApiDestinationState>):
 The state of the API destination that was created by the request.
- creation_time(Option<DateTime>):
 A time stamp indicating the time that the API destination was created.
- last_modified_time(Option<DateTime>):
 A time stamp indicating the time that the API destination was last modified.
On failure, responds with SdkError<CreateApiDestinationError>

source

pub fn create_archive(&self) -> CreateArchive

Constructs a fluent builder for the CreateArchive operation.

The fluent builder is configurable:
- archive_name(impl Into<String>) / set_archive_name(Option<String>):
 The name for the archive to create.
- event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
 The ARN of the event bus that sends events to the archive.
- description(impl Into<String>) / set_description(Option<String>):
 A description for the archive.
- event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
 An event pattern to use to filter events sent to the archive.
- retention_days(i32) / set_retention_days(Option<i32>):
 The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely
On success, responds with CreateArchiveOutput with field(s):
- archive_arn(Option<String>):
 The ARN of the archive that was created.
- state(Option<ArchiveState>):
 The state of the archive that was created.
- state_reason(Option<String>):
 The reason that the archive is in the state.
- creation_time(Option<DateTime>):
 The time at which the archive was created.
On failure, responds with SdkError<CreateArchiveError>

source

pub fn create_connection(&self) -> CreateConnection

Constructs a fluent builder for the CreateConnection operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name for the connection to create.
- description(impl Into<String>) / set_description(Option<String>):
 A description for the connection to create.
- authorization_type(ConnectionAuthorizationType) / set_authorization_type(Option<ConnectionAuthorizationType>):
 The type of authorization to use for the connection.
- auth_parameters(CreateConnectionAuthRequestParameters) / set_auth_parameters(Option<CreateConnectionAuthRequestParameters>):
 A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
On success, responds with CreateConnectionOutput with field(s):
- connection_arn(Option<String>):
 The ARN of the connection that was created by the request.
- connection_state(Option<ConnectionState>):
 The state of the connection that was created by the request.
- creation_time(Option<DateTime>):
 A time stamp for the time that the connection was created.
- last_modified_time(Option<DateTime>):
 A time stamp for the time that the connection was last updated.
On failure, responds with SdkError<CreateConnectionError>

source

pub fn create_endpoint(&self) -> CreateEndpoint

Constructs a fluent builder for the CreateEndpoint operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the global endpoint. For example, “Name”:“us-east-2-custom_bus_A-endpoint”.
- description(impl Into<String>) / set_description(Option<String>):
 A description of the global endpoint.
- routing_config(RoutingConfig) / set_routing_config(Option<RoutingConfig>):
 Configure the routing policy, including the health check and secondary Region..
- replication_config(ReplicationConfig) / set_replication_config(Option<ReplicationConfig>):
 Enable or disable event replication.
- event_buses(Vec<EndpointEventBus>) / set_event_buses(Option<Vec<EndpointEventBus>>):
 Define the event buses used.
 
 The names of the event buses must be identical in each Region.
- role_arn(impl Into<String>) / set_role_arn(Option<String>):
 The ARN of the role used for replication.
On success, responds with CreateEndpointOutput with field(s):
- name(Option<String>):
 The name of the endpoint that was created by this request.
- arn(Option<String>):
 The ARN of the endpoint that was created by this request.
- routing_config(Option<RoutingConfig>):
 The routing configuration defined by this request.
- replication_config(Option<ReplicationConfig>):
 Whether event replication was enabled or disabled by this request.
- event_buses(Option<Vec<EndpointEventBus>>):
 The event buses used by this request.
- role_arn(Option<String>):
 The ARN of the role used by event replication for this request.
- state(Option<EndpointState>):
 The state of the endpoint that was created by this request.
On failure, responds with SdkError<CreateEndpointError>

source

pub fn create_event_bus(&self) -> CreateEventBus

Constructs a fluent builder for the CreateEventBus operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the new event bus.
 
 Event bus names cannot contain the / character. You can’t use the name default for a custom event bus, as this name is already used for your account’s default event bus.
 
 If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
- event_source_name(impl Into<String>) / set_event_source_name(Option<String>):
 If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 Tags to associate with the event bus.
On success, responds with CreateEventBusOutput with field(s):
- event_bus_arn(Option<String>):
 The ARN of the new event bus.
On failure, responds with SdkError<CreateEventBusError>

source

pub fn create_partner_event_source(&self) -> CreatePartnerEventSource

Constructs a fluent builder for the CreatePartnerEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The Amazon Web Services account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.
- account(impl Into<String>) / set_account(Option<String>):
 The Amazon Web Services account ID that is permitted to create a matching partner event bus for this partner event source.
On success, responds with CreatePartnerEventSourceOutput with field(s):
- event_source_arn(Option<String>):
 The ARN of the partner event source.
On failure, responds with SdkError<CreatePartnerEventSourceError>

source

pub fn deactivate_event_source(&self) -> DeactivateEventSource

Constructs a fluent builder for the DeactivateEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the partner event source to deactivate.
On success, responds with DeactivateEventSourceOutput
On failure, responds with SdkError<DeactivateEventSourceError>

source

pub fn deauthorize_connection(&self) -> DeauthorizeConnection

Constructs a fluent builder for the DeauthorizeConnection operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the connection to remove authorization from.
On success, responds with DeauthorizeConnectionOutput with field(s):
- connection_arn(Option<String>):
 The ARN of the connection that authorization was removed from.
- connection_state(Option<ConnectionState>):
 The state of the connection.
- creation_time(Option<DateTime>):
 A time stamp for the time that the connection was created.
- last_modified_time(Option<DateTime>):
 A time stamp for the time that the connection was last updated.
- last_authorized_time(Option<DateTime>):
 A time stamp for the time that the connection was last authorized.
On failure, responds with SdkError<DeauthorizeConnectionError>

source

pub fn delete_api_destination(&self) -> DeleteApiDestination

Constructs a fluent builder for the DeleteApiDestination operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the destination to delete.
On success, responds with DeleteApiDestinationOutput
On failure, responds with SdkError<DeleteApiDestinationError>

source

pub fn delete_archive(&self) -> DeleteArchive

Constructs a fluent builder for the DeleteArchive operation.

The fluent builder is configurable:
- archive_name(impl Into<String>) / set_archive_name(Option<String>):
 The name of the archive to delete.
On success, responds with DeleteArchiveOutput
On failure, responds with SdkError<DeleteArchiveError>

source

pub fn delete_connection(&self) -> DeleteConnection

Constructs a fluent builder for the DeleteConnection operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the connection to delete.
On success, responds with DeleteConnectionOutput with field(s):
- connection_arn(Option<String>):
 The ARN of the connection that was deleted.
- connection_state(Option<ConnectionState>):
 The state of the connection before it was deleted.
- creation_time(Option<DateTime>):
 A time stamp for the time that the connection was created.
- last_modified_time(Option<DateTime>):
 A time stamp for the time that the connection was last modified before it was deleted.
- last_authorized_time(Option<DateTime>):
 A time stamp for the time that the connection was last authorized before it wa deleted.
On failure, responds with SdkError<DeleteConnectionError>

source

pub fn delete_endpoint(&self) -> DeleteEndpoint

Constructs a fluent builder for the DeleteEndpoint operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the endpoint you want to delete. For example, “Name”:“us-east-2-custom_bus_A-endpoint”..
On success, responds with DeleteEndpointOutput
On failure, responds with SdkError<DeleteEndpointError>

source

pub fn delete_event_bus(&self) -> DeleteEventBus

Constructs a fluent builder for the DeleteEventBus operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the event bus to delete.
On success, responds with DeleteEventBusOutput
On failure, responds with SdkError<DeleteEventBusError>

source

pub fn delete_partner_event_source(&self) -> DeletePartnerEventSource

Constructs a fluent builder for the DeletePartnerEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the event source to delete.
- account(impl Into<String>) / set_account(Option<String>):
 The Amazon Web Services account ID of the Amazon Web Services customer that the event source was created for.
On success, responds with DeletePartnerEventSourceOutput
On failure, responds with SdkError<DeletePartnerEventSourceError>

source

pub fn delete_rule(&self) -> DeleteRule

Constructs a fluent builder for the DeleteRule operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- force(bool) / set_force(bool):
 If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
On success, responds with DeleteRuleOutput
On failure, responds with SdkError<DeleteRuleError>

source

pub fn describe_api_destination(&self) -> DescribeApiDestination

Constructs a fluent builder for the DescribeApiDestination operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the API destination to retrieve.
On success, responds with DescribeApiDestinationOutput with field(s):
- api_destination_arn(Option<String>):
 The ARN of the API destination retrieved.
- name(Option<String>):
 The name of the API destination retrieved.
- description(Option<String>):
 The description for the API destination retrieved.
- api_destination_state(Option<ApiDestinationState>):
 The state of the API destination retrieved.
- connection_arn(Option<String>):
 The ARN of the connection specified for the API destination retrieved.
- invocation_endpoint(Option<String>):
 The URL to use to connect to the HTTP endpoint.
- http_method(Option<ApiDestinationHttpMethod>):
 The method to use to connect to the HTTP endpoint.
- invocation_rate_limit_per_second(Option<i32>):
 The maximum number of invocations per second to specified for the API destination. Note that if you set the invocation rate maximum to a value lower the rate necessary to send all events received on to the destination HTTP endpoint, some events may not be delivered within the 24-hour retry window. If you plan to set the rate lower than the rate necessary to deliver all events, consider using a dead-letter queue to catch events that are not delivered within 24 hours.
- creation_time(Option<DateTime>):
 A time stamp for the time that the API destination was created.
- last_modified_time(Option<DateTime>):
 A time stamp for the time that the API destination was last modified.
On failure, responds with SdkError<DescribeApiDestinationError>

source

pub fn describe_archive(&self) -> DescribeArchive

Constructs a fluent builder for the DescribeArchive operation.

The fluent builder is configurable:
- archive_name(impl Into<String>) / set_archive_name(Option<String>):
 The name of the archive to retrieve.
On success, responds with DescribeArchiveOutput with field(s):
- archive_arn(Option<String>):
 The ARN of the archive.
- archive_name(Option<String>):
 The name of the archive.
- event_source_arn(Option<String>):
 The ARN of the event source associated with the archive.
- description(Option<String>):
 The description of the archive.
- event_pattern(Option<String>):
 The event pattern used to filter events sent to the archive.
- state(Option<ArchiveState>):
 The state of the archive.
- state_reason(Option<String>):
 The reason that the archive is in the state.
- retention_days(Option<i32>):
 The number of days to retain events for in the archive.
- size_bytes(i64):
 The size of the archive in bytes.
- event_count(i64):
 The number of events in the archive.
- creation_time(Option<DateTime>):
 The time at which the archive was created.
On failure, responds with SdkError<DescribeArchiveError>

source

pub fn describe_connection(&self) -> DescribeConnection

Constructs a fluent builder for the DescribeConnection operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the connection to retrieve.
On success, responds with DescribeConnectionOutput with field(s):
- connection_arn(Option<String>):
 The ARN of the connection retrieved.
- name(Option<String>):
 The name of the connection retrieved.
- description(Option<String>):
 The description for the connection retrieved.
- connection_state(Option<ConnectionState>):
 The state of the connection retrieved.
- state_reason(Option<String>):
 The reason that the connection is in the current connection state.
- authorization_type(Option<ConnectionAuthorizationType>):
 The type of authorization specified for the connection.
- secret_arn(Option<String>):
 The ARN of the secret created from the authorization parameters specified for the connection.
- auth_parameters(Option<ConnectionAuthResponseParameters>):
 The parameters to use for authorization for the connection.
- creation_time(Option<DateTime>):
 A time stamp for the time that the connection was created.
- last_modified_time(Option<DateTime>):
 A time stamp for the time that the connection was last modified.
- last_authorized_time(Option<DateTime>):
 A time stamp for the time that the connection was last authorized.
On failure, responds with SdkError<DescribeConnectionError>

source

pub fn describe_endpoint(&self) -> DescribeEndpoint

Constructs a fluent builder for the DescribeEndpoint operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the endpoint you want to get information about. For example, “Name”:“us-east-2-custom_bus_A-endpoint”.
- home_region(impl Into<String>) / set_home_region(Option<String>):
 The primary Region of the endpoint you want to get information about. For example “HomeRegion”: “us-east-1”.
On success, responds with DescribeEndpointOutput with field(s):
- name(Option<String>):
 The name of the endpoint you asked for information about.
- description(Option<String>):
 The description of the endpoint you asked for information about.
- arn(Option<String>):
 The ARN of the endpoint you asked for information about.
- routing_config(Option<RoutingConfig>):
 The routing configuration of the endpoint you asked for information about.
- replication_config(Option<ReplicationConfig>):
 Whether replication is enabled or disabled for the endpoint you asked for information about.
- event_buses(Option<Vec<EndpointEventBus>>):
 The event buses being used by the endpoint you asked for information about.
- role_arn(Option<String>):
 The ARN of the role used by the endpoint you asked for information about.
- endpoint_id(Option<String>):
 The ID of the endpoint you asked for information about.
- endpoint_url(Option<String>):
 The URL of the endpoint you asked for information about.
- state(Option<EndpointState>):
 The current state of the endpoint you asked for information about.
- state_reason(Option<String>):
 The reason the endpoint you asked for information about is in its current state.
- creation_time(Option<DateTime>):
 The time the endpoint you asked for information about was created.
- last_modified_time(Option<DateTime>):
 The last time the endpoint you asked for information about was modified.
On failure, responds with SdkError<DescribeEndpointError>

source

pub fn describe_event_bus(&self) -> DescribeEventBus

Constructs a fluent builder for the DescribeEventBus operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.
On success, responds with DescribeEventBusOutput with field(s):
- name(Option<String>):
 The name of the event bus. Currently, this is always default.
- arn(Option<String>):
 The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
- policy(Option<String>):
 The policy that enables the external account to send events to your account.
On failure, responds with SdkError<DescribeEventBusError>

source

pub fn describe_event_source(&self) -> DescribeEventSource

Constructs a fluent builder for the DescribeEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the partner event source to display the details of.
On success, responds with DescribeEventSourceOutput with field(s):
- arn(Option<String>):
 The ARN of the partner event source.
- created_by(Option<String>):
 The name of the SaaS partner that created the event source.
- creation_time(Option<DateTime>):
 The date and time that the event source was created.
- expiration_time(Option<DateTime>):
 The date and time that the event source will expire if you do not create a matching event bus.
- name(Option<String>):
 The name of the partner event source.
- state(Option<EventSourceState>):
 The state of the event source. If it is ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it is PENDING, either you haven’t yet created a matching event bus, or that event bus is deactivated. If it is DELETED, you have created a matching event bus, but the event source has since been deleted.
On failure, responds with SdkError<DescribeEventSourceError>

source

pub fn describe_partner_event_source(&self) -> DescribePartnerEventSource

Constructs a fluent builder for the DescribePartnerEventSource operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the event source to display.
On success, responds with DescribePartnerEventSourceOutput with field(s):
- arn(Option<String>):
 The ARN of the event source.
- name(Option<String>):
 The name of the event source.
On failure, responds with SdkError<DescribePartnerEventSourceError>

source

pub fn describe_replay(&self) -> DescribeReplay

Constructs a fluent builder for the DescribeReplay operation.

The fluent builder is configurable:
- replay_name(impl Into<String>) / set_replay_name(Option<String>):
 The name of the replay to retrieve.
On success, responds with DescribeReplayOutput with field(s):
- replay_name(Option<String>):
 The name of the replay.
- replay_arn(Option<String>):
 The ARN of the replay.
- description(Option<String>):
 The description of the replay.
- state(Option<ReplayState>):
 The current state of the replay.
- state_reason(Option<String>):
 The reason that the replay is in the current state.
- event_source_arn(Option<String>):
 The ARN of the archive events were replayed from.
- destination(Option<ReplayDestination>):
 A ReplayDestination object that contains details about the replay.
- event_start_time(Option<DateTime>):
 The time stamp of the first event that was last replayed from the archive.
- event_end_time(Option<DateTime>):
 The time stamp for the last event that was replayed from the archive.
- event_last_replayed_time(Option<DateTime>):
 The time that the event was last replayed.
- replay_start_time(Option<DateTime>):
 A time stamp for the time that the replay started.
- replay_end_time(Option<DateTime>):
 A time stamp for the time that the replay stopped.
On failure, responds with SdkError<DescribeReplayError>

source

pub fn describe_rule(&self) -> DescribeRule

Constructs a fluent builder for the DescribeRule operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
On success, responds with DescribeRuleOutput with field(s):
- name(Option<String>):
 The name of the rule.
- arn(Option<String>):
 The Amazon Resource Name (ARN) of the rule.
- event_pattern(Option<String>):
 The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
- schedule_expression(Option<String>):
 The scheduling expression. For example, “cron(0 20 * * ? *)”, “rate(5 minutes)”.
- state(Option<RuleState>):
 Specifies whether the rule is enabled or disabled.
- description(Option<String>):
 The description of the rule.
- role_arn(Option<String>):
 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- managed_by(Option<String>):
 If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.
- event_bus_name(Option<String>):
 The name of the event bus associated with the rule.
- created_by(Option<String>):
 The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.
On failure, responds with SdkError<DescribeRuleError>

source

pub fn disable_rule(&self) -> DisableRule

Constructs a fluent builder for the DisableRule operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
On success, responds with DisableRuleOutput
On failure, responds with SdkError<DisableRuleError>

source

pub fn enable_rule(&self) -> EnableRule

Constructs a fluent builder for the EnableRule operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
On success, responds with EnableRuleOutput
On failure, responds with SdkError<EnableRuleError>

source

pub fn list_api_destinations(&self) -> ListApiDestinations

Constructs a fluent builder for the ListApiDestinations operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.
- connection_arn(impl Into<String>) / set_connection_arn(Option<String>):
 The ARN of the connection specified for the API destination.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of API destinations to include in the response.
On success, responds with ListApiDestinationsOutput with field(s):
- api_destinations(Option<Vec<ApiDestination>>):
 An array of ApiDestination objects that include information about an API destination.
- next_token(Option<String>):
 A token you can use in a subsequent request to retrieve the next set of results.
On failure, responds with SdkError<ListApiDestinationsError>

source

pub fn list_archives(&self) -> ListArchives

Constructs a fluent builder for the ListArchives operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.
- event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
 The ARN of the event source associated with the archive.
- state(ArchiveState) / set_state(Option<ArchiveState>):
 The state of the archive.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of results to return.
On success, responds with ListArchivesOutput with field(s):
- archives(Option<Vec<Archive>>):
 An array of Archive objects that include details about an archive.
- next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
On failure, responds with SdkError<ListArchivesError>

source

pub fn list_connections(&self) -> ListConnections

Constructs a fluent builder for the ListConnections operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.
- connection_state(ConnectionState) / set_connection_state(Option<ConnectionState>):
 The state of the connection.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of connections to return.
On success, responds with ListConnectionsOutput with field(s):
- connections(Option<Vec<Connection>>):
 An array of connections objects that include details about the connections.
- next_token(Option<String>):
 A token you can use in a subsequent request to retrieve the next set of results.
On failure, responds with SdkError<ListConnectionsError>

source

pub fn list_endpoints(&self) -> ListEndpoints

Constructs a fluent builder for the ListEndpoints operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 A value that will return a subset of the endpoints associated with this account. For example, “NamePrefix”: “ABC” will return all endpoints with “ABC” in the name.
- home_region(impl Into<String>) / set_home_region(Option<String>):
 The primary Region of the endpoints associated with this account. For example “HomeRegion”: “us-east-1”.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of results returned by the call.
On success, responds with ListEndpointsOutput with field(s):
- endpoints(Option<Vec<Endpoint>>):
 The endpoints returned by the call.
- next_token(Option<String>):
 If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
On failure, responds with SdkError<ListEndpointsError>

source

pub fn list_event_buses(&self) -> ListEventBuses

Constructs a fluent builder for the ListEventBuses operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 Specifying this limits the results to only those event buses with names that start with the specified prefix.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
On success, responds with ListEventBusesOutput with field(s):
- event_buses(Option<Vec<EventBus>>):
 This list of event buses.
- next_token(Option<String>):
 A token you can use in a subsequent operation to retrieve the next set of results.
On failure, responds with SdkError<ListEventBusesError>

source

pub fn list_event_sources(&self) -> ListEventSources

Constructs a fluent builder for the ListEventSources operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 Specifying this limits the results to only those partner event sources with names that start with the specified prefix.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
On success, responds with ListEventSourcesOutput with field(s):
- event_sources(Option<Vec<EventSource>>):
 The list of event sources.
- next_token(Option<String>):
 A token you can use in a subsequent operation to retrieve the next set of results.
On failure, responds with SdkError<ListEventSourcesError>

source

pub fn list_partner_event_source_accounts(
&self
) -> ListPartnerEventSourceAccounts

Constructs a fluent builder for the ListPartnerEventSourceAccounts operation.

The fluent builder is configurable:
- event_source_name(impl Into<String>) / set_event_source_name(Option<String>):
 The name of the partner event source to display account information about.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
- limit(i32) / set_limit(Option<i32>):
 Specifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
On success, responds with ListPartnerEventSourceAccountsOutput with field(s):
- partner_event_source_accounts(Option<Vec<PartnerEventSourceAccount>>):
 The list of partner event sources returned by the operation.
- next_token(Option<String>):
 A token you can use in a subsequent operation to retrieve the next set of results.
On failure, responds with SdkError<ListPartnerEventSourceAccountsError>

source

pub fn list_partner_event_sources(&self) -> ListPartnerEventSources

Constructs a fluent builder for the ListPartnerEventSources operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 If you specify this, the results are limited to only those partner event sources that start with the string you specify.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to this operation. Specifying this retrieves the next set of results.
- limit(i32) / set_limit(Option<i32>):
 pecifying this limits the number of results returned by this operation. The operation also returns a NextToken which you can use in a subsequent operation to retrieve the next set of results.
On success, responds with ListPartnerEventSourcesOutput with field(s):
- partner_event_sources(Option<Vec<PartnerEventSource>>):
 The list of partner event sources returned by the operation.
- next_token(Option<String>):
 A token you can use in a subsequent operation to retrieve the next set of results.
On failure, responds with SdkError<ListPartnerEventSourcesError>

source

pub fn list_replays(&self) -> ListReplays

Constructs a fluent builder for the ListReplays operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.
- state(ReplayState) / set_state(Option<ReplayState>):
 The state of the replay.
- event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
 The ARN of the archive from which the events are replayed.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of replays to retrieve.
On success, responds with ListReplaysOutput with field(s):
- replays(Option<Vec<Replay>>):
 An array of Replay objects that contain information about the replay.
- next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
On failure, responds with SdkError<ListReplaysError>

source

pub fn list_rule_names_by_target(&self) -> ListRuleNamesByTarget

Constructs a fluent builder for the ListRuleNamesByTarget operation.

The fluent builder is configurable:
- target_arn(impl Into<String>) / set_target_arn(Option<String>):
 The Amazon Resource Name (ARN) of the target resource.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of results to return.
On success, responds with ListRuleNamesByTargetOutput with field(s):
- rule_names(Option<Vec<String>>):
 The names of the rules that can invoke the given target.
- next_token(Option<String>):
 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
On failure, responds with SdkError<ListRuleNamesByTargetError>

source

pub fn list_rules(&self) -> ListRules

Constructs a fluent builder for the ListRules operation.

The fluent builder is configurable:
- name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
 The prefix matching the rule name.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of results to return.
On success, responds with ListRulesOutput with field(s):
- rules(Option<Vec<Rule>>):
 The rules that match the specified criteria.
- next_token(Option<String>):
 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
On failure, responds with SdkError<ListRulesError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the EventBridge resource for which you want to view tags.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<Vec<Tag>>):
 The list of tag keys and values associated with the resource you specified
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn list_targets_by_rule(&self) -> ListTargetsByRule

Constructs a fluent builder for the ListTargetsByRule operation.

The fluent builder is configurable:
- rule(impl Into<String>) / set_rule(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The token returned by a previous call to retrieve the next set of results.
- limit(i32) / set_limit(Option<i32>):
 The maximum number of results to return.
On success, responds with ListTargetsByRuleOutput with field(s):
- targets(Option<Vec<Target>>):
 The targets assigned to the rule.
- next_token(Option<String>):
 Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
On failure, responds with SdkError<ListTargetsByRuleError>

source

pub fn put_events(&self) -> PutEvents

Constructs a fluent builder for the PutEvents operation.

The fluent builder is configurable:
- entries(Vec<PutEventsRequestEntry>) / set_entries(Option<Vec<PutEventsRequestEntry>>):
 The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.
- endpoint_id(impl Into<String>) / set_endpoint_id(Option<String>):
 The URL subdomain of the endpoint. For example, if the URL for Endpoint is abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
 
 When using Java, you must include auth-crt on the class path.
On success, responds with PutEventsOutput with field(s):
- failed_entry_count(i32):
 The number of failed entries.
- entries(Option<Vec<PutEventsResultEntry>>):
 The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
On failure, responds with SdkError<PutEventsError>

source

pub fn put_partner_events(&self) -> PutPartnerEvents

Constructs a fluent builder for the PutPartnerEvents operation.

The fluent builder is configurable:
- entries(Vec<PutPartnerEventsRequestEntry>) / set_entries(Option<Vec<PutPartnerEventsRequestEntry>>):
 The list of events to write to the event bus.
On success, responds with PutPartnerEventsOutput with field(s):
- failed_entry_count(i32):
 The number of events from this operation that could not be written to the partner event bus.
- entries(Option<Vec<PutPartnerEventsResultEntry>>):
 The list of events from this operation that were successfully written to the partner event bus.
On failure, responds with SdkError<PutPartnerEventsError>

source

pub fn put_permission(&self) -> PutPermission

Constructs a fluent builder for the PutPermission operation.

The fluent builder is configurable:
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name of the event bus associated with the rule. If you omit this, the default event bus is used.
- action(impl Into<String>) / set_action(Option<String>):
 The action that you are enabling the other account to perform.
- principal(impl Into<String>) / set_principal(Option<String>):
 The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify “” to permit any account to put events to your default event bus.
 
 If you specify “” without specifying Condition, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
- statement_id(impl Into<String>) / set_statement_id(Option<String>):
 An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.
 
 Each StatementId must be unique.
- condition(Condition) / set_condition(Option<Condition>):
 This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.
 
 If you specify Condition with an Amazon Web Services organization ID, and specify “*” as the value for Principal, you grant permission to all the accounts in the named organization.
 
 The Condition is a JSON string which must contain Type, Key, and Value fields.
- policy(impl Into<String>) / set_policy(Option<String>):
 A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.
On success, responds with PutPermissionOutput
On failure, responds with SdkError<PutPermissionError>

source

pub fn put_rule(&self) -> PutRule

Constructs a fluent builder for the PutRule operation.

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the rule that you are creating or updating.
- schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
 The scheduling expression. For example, “cron(0 20 * * ? *)” or “rate(5 minutes)”.
- event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
 The event pattern. For more information, see EventBridge event patterns in the Amazon EventBridge User Guide.
- state(RuleState) / set_state(Option<RuleState>):
 Indicates whether the rule is enabled or disabled.
- description(impl Into<String>) / set_description(Option<String>):
 A description of the rule.
- role_arn(impl Into<String>) / set_role_arn(Option<String>):
 The Amazon Resource Name (ARN) of the IAM role associated with the rule.
 
 If you’re setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 The list of key-value pairs to associate with the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
On success, responds with PutRuleOutput with field(s):
- rule_arn(Option<String>):
 The Amazon Resource Name (ARN) of the rule.
On failure, responds with SdkError<PutRuleError>

source

pub fn put_targets(&self) -> PutTargets

Constructs a fluent builder for the PutTargets operation.

The fluent builder is configurable:
- rule(impl Into<String>) / set_rule(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- targets(Vec<Target>) / set_targets(Option<Vec<Target>>):
 The targets to update or add to the rule.
On success, responds with PutTargetsOutput with field(s):
- failed_entry_count(i32):
 The number of failed entries.
- failed_entries(Option<Vec<PutTargetsResultEntry>>):
 The failed target entries.
On failure, responds with SdkError<PutTargetsError>

source

pub fn remove_permission(&self) -> RemovePermission

Constructs a fluent builder for the RemovePermission operation.

The fluent builder is configurable:
- statement_id(impl Into<String>) / set_statement_id(Option<String>):
 The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
- remove_all_permissions(bool) / set_remove_all_permissions(bool):
 Specifies whether to remove all permissions.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.
On success, responds with RemovePermissionOutput
On failure, responds with SdkError<RemovePermissionError>

source

pub fn remove_targets(&self) -> RemoveTargets

Constructs a fluent builder for the RemoveTargets operation.

The fluent builder is configurable:
- rule(impl Into<String>) / set_rule(Option<String>):
 The name of the rule.
- event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
 The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
- ids(Vec<String>) / set_ids(Option<Vec<String>>):
 The IDs of the targets to remove from the rule.
- force(bool) / set_force(bool):
 If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.
On success, responds with RemoveTargetsOutput with field(s):
- failed_entry_count(i32):
 The number of failed entries.
- failed_entries(Option<Vec<RemoveTargetsResultEntry>>):
 The failed target entries.
On failure, responds with SdkError<RemoveTargetsError>

source

pub fn start_replay(&self) -> StartReplay

Constructs a fluent builder for the StartReplay operation.

The fluent builder is configurable:
- replay_name(impl Into<String>) / set_replay_name(Option<String>):
 The name of the replay to start.
- description(impl Into<String>) / set_description(Option<String>):
 A description for the replay to start.
- event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
 The ARN of the archive to replay events from.
- event_start_time(DateTime) / set_event_start_time(Option<DateTime>):
 A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
- event_end_time(DateTime) / set_event_end_time(Option<DateTime>):
 A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.
- destination(ReplayDestination) / set_destination(Option<ReplayDestination>):
 A ReplayDestination object that includes details about the destination for the replay.
On success, responds with StartReplayOutput with field(s):
- replay_arn(Option<String>):
 The ARN of the replay.
- state(Option<ReplayState>):
 The state of the replay.
- state_reason(Option<String>):
 The reason that the replay is in the state.
- replay_start_time(Option<DateTime>):
 The time at which the replay started.
On failure, responds with SdkError<StartReplayError>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The ARN of the EventBridge resource that you’re adding tags to.
- tags(Vec<Tag>) / set_tags(Option<Vec<Tag>>):
 The list of key-value pairs to associate with the resource.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>

source

pub fn test_event_pattern(&self) -> TestEventPattern

Constructs a fluent builder for the TestEventPattern operation.

The fluent builder is configurable:
- event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
 The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
- event(impl Into<String>) / set_event(Option<String>):
 The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in Amazon Web Services Events, and the following fields are mandatory:
 - id
 - account
 - source
 - time
 - region
 - resources
 - detail-type
On success, responds with TestEventPatternOutput with field(s):
- result(bool):
  Indicates whether the event matches the event pattern.
On failure, responds with SdkError<TestEventPatternError>