Struct aws_sdk_eventbridge::Client

pub struct Client { /* private fields */ }

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.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_eventbridge::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_eventbridge::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the ActivateEventSource operation has a Client::activate_event_source, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.activate_event_source()
    .name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn activate_event_source(&self) -> ActivateEventSourceFluentBuilder

Constructs a fluent builder for the ActivateEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the partner event source to activate.

    
    
• On success, responds with ActivateEventSourceOutput
• On failure, responds with SdkError<ActivateEventSourceError>

impl Client

pub fn cancel_replay(&self) -> CancelReplayFluentBuilder

Constructs a fluent builder for the CancelReplay operation.

• The fluent builder is configurable:
  • replay_name(impl Into<String>) / set_replay_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn create_api_destination(&self) -> CreateApiDestinationFluentBuilder

Constructs a fluent builder for the CreateApiDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the API destination to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the API destination to create.

    
    
  • connection_arn(impl Into<String>) / set_connection_arn(Option<String>):
    required: true
    

    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>):
    required: true
    

    The URL to the HTTP invocation endpoint for the API destination.

    
    
  • http_method(ApiDestinationHttpMethod) / set_http_method(Option<ApiDestinationHttpMethod>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn create_archive(&self) -> CreateArchiveFluentBuilder

Constructs a fluent builder for the CreateArchive operation.

• The fluent builder is configurable:
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: true
    

    The name for the archive to create.

    
    
  • event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
    required: true
    

    The ARN of the event bus that sends events to the archive.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the archive.

    
    
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: false
    

    An event pattern to use to filter events sent to the archive.

    
    
  • retention_days(i32) / set_retention_days(Option<i32>):
    required: false
    

    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>

impl Client

pub fn create_connection(&self) -> CreateConnectionFluentBuilder

Constructs a fluent builder for the CreateConnection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name for the connection to create.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the connection to create.

    
    
  • authorization_type(ConnectionAuthorizationType) / set_authorization_type(Option<ConnectionAuthorizationType>):
    required: true
    

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    
    
  • auth_parameters(CreateConnectionAuthRequestParameters) / set_auth_parameters(Option<CreateConnectionAuthRequestParameters>):
    required: true
    

    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>

impl Client

pub fn create_endpoint(&self) -> CreateEndpointFluentBuilder

Constructs a fluent builder for the CreateEndpoint operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the global endpoint. For example, “Name”:“us-east-2-custom_bus_A-endpoint”.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the global endpoint.

    
    
  • routing_config(RoutingConfig) / set_routing_config(Option<RoutingConfig>):
    required: true
    

    Configure the routing policy, including the health check and secondary Region..

    
    
  • replication_config(ReplicationConfig) / set_replication_config(Option<ReplicationConfig>):
    required: false
    

    Enable or disable event replication. The default state is ENABLED which means you must supply a RoleArn. If you don’t have a RoleArn or you don’t want event replication enabled, set the state to DISABLED.

    
    
  • event_buses(EndpointEventBus) / set_event_buses(Option<Vec::<EndpointEventBus>>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn create_event_bus(&self) -> CreateEventBusFluentBuilder

Constructs a fluent builder for the CreateEventBus operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the new event bus.

    Custom event bus names can’t contain the / character, but you can use the / character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.

    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.

    
    
  • event_source_name(impl Into<String>) / set_event_source_name(Option<String>):
    required: false
    

    If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    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>

impl Client

pub fn create_partner_event_source( &self ) -> CreatePartnerEventSourceFluentBuilder

Constructs a fluent builder for the CreatePartnerEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>

impl Client

pub fn deactivate_event_source(&self) -> DeactivateEventSourceFluentBuilder

Constructs a fluent builder for the DeactivateEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the partner event source to deactivate.

    
    
• On success, responds with DeactivateEventSourceOutput
• On failure, responds with SdkError<DeactivateEventSourceError>

impl Client

pub fn deauthorize_connection(&self) -> DeauthorizeConnectionFluentBuilder

Constructs a fluent builder for the DeauthorizeConnection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn delete_api_destination(&self) -> DeleteApiDestinationFluentBuilder

Constructs a fluent builder for the DeleteApiDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the destination to delete.

    
    
• On success, responds with DeleteApiDestinationOutput
• On failure, responds with SdkError<DeleteApiDestinationError>

impl Client

pub fn delete_archive(&self) -> DeleteArchiveFluentBuilder

Constructs a fluent builder for the DeleteArchive operation.

• The fluent builder is configurable:
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: true
    

    The name of the archive to delete.

    
    
• On success, responds with DeleteArchiveOutput
• On failure, responds with SdkError<DeleteArchiveError>

impl Client

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder

Constructs a fluent builder for the DeleteEndpoint operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn delete_event_bus(&self) -> DeleteEventBusFluentBuilder

Constructs a fluent builder for the DeleteEventBus operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the event bus to delete.

    
    
• On success, responds with DeleteEventBusOutput
• On failure, responds with SdkError<DeleteEventBusError>

impl Client

pub fn delete_partner_event_source( &self ) -> DeletePartnerEventSourceFluentBuilder

Constructs a fluent builder for the DeletePartnerEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the event source to delete.

    
    
  • account(impl Into<String>) / set_account(Option<String>):
    required: true
    

    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>

impl Client

pub fn delete_rule(&self) -> DeleteRuleFluentBuilder

Constructs a fluent builder for the DeleteRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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(Option<bool>):
    required: false
    

    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>

impl Client

pub fn describe_api_destination(&self) -> DescribeApiDestinationFluentBuilder

Constructs a fluent builder for the DescribeApiDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_archive(&self) -> DescribeArchiveFluentBuilder

Constructs a fluent builder for the DescribeArchive operation.

• The fluent builder is configurable:
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_connection(&self) -> DescribeConnectionFluentBuilder

Constructs a fluent builder for the DescribeConnection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_endpoint(&self) -> DescribeEndpointFluentBuilder

Constructs a fluent builder for the DescribeEndpoint operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>):
    required: false
    

    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>

impl Client

pub fn describe_event_bus(&self) -> DescribeEventBusFluentBuilder

Constructs a fluent builder for the DescribeEventBus operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn describe_event_source(&self) -> DescribeEventSourceFluentBuilder

Constructs a fluent builder for the DescribeEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_partner_event_source( &self ) -> DescribePartnerEventSourceFluentBuilder

Constructs a fluent builder for the DescribePartnerEventSource operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_replay(&self) -> DescribeReplayFluentBuilder

Constructs a fluent builder for the DescribeReplay operation.

• The fluent builder is configurable:
  • replay_name(impl Into<String>) / set_replay_name(Option<String>):
    required: true
    

    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>

impl Client

pub fn describe_rule(&self) -> DescribeRuleFluentBuilder

Constructs a fluent builder for the DescribeRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn disable_rule(&self) -> DisableRuleFluentBuilder

Constructs a fluent builder for the DisableRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn enable_rule(&self) -> EnableRuleFluentBuilder

Constructs a fluent builder for the EnableRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn list_api_destinations(&self) -> ListApiDestinationsFluentBuilder

Constructs a fluent builder for the ListApiDestinations operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    The ARN of the connection specified for the API destination.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_archives(&self) -> ListArchivesFluentBuilder

Constructs a fluent builder for the ListArchives operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    The ARN of the event source associated with the archive.

    
    
  • state(ArchiveState) / set_state(Option<ArchiveState>):
    required: false
    

    The state of the archive.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_connections(&self) -> ListConnectionsFluentBuilder

Constructs a fluent builder for the ListConnections operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    The state of the connection.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_endpoints(&self) -> ListEndpointsFluentBuilder

Constructs a fluent builder for the ListEndpoints operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn list_event_buses(&self) -> ListEventBusesFluentBuilder

Constructs a fluent builder for the ListEventBuses operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_event_sources(&self) -> ListEventSourcesFluentBuilder

Constructs a fluent builder for the ListEventSources operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_partner_event_source_accounts( &self ) -> ListPartnerEventSourceAccountsFluentBuilder

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>):
    required: true
    

    The name of the partner event source to display account information about.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_partner_event_sources(&self) -> ListPartnerEventSourcesFluentBuilder

Constructs a fluent builder for the ListPartnerEventSources operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: true
    

    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>):
    required: false
    

    The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_replays(&self) -> ListReplaysFluentBuilder

Constructs a fluent builder for the ListReplays operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

    
    
  • state(ReplayState) / set_state(Option<ReplayState>):
    required: false
    

    The state of the replay.

    
    
  • event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
    required: false
    

    The ARN of the archive from which the events are replayed.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_rule_names_by_target(&self) -> ListRuleNamesByTargetFluentBuilder

Constructs a fluent builder for the ListRuleNamesByTarget operation.

• The fluent builder is configurable:
  • target_arn(impl Into<String>) / set_target_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the target resource.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_rules(&self) -> ListRulesFluentBuilder

Constructs a fluent builder for the ListRules operation.

• The fluent builder is configurable:
  • name_prefix(impl Into<String>) / set_name_prefix(Option<String>):
    required: false
    

    The prefix matching the rule name.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    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>

impl Client

pub fn list_targets_by_rule(&self) -> ListTargetsByRuleFluentBuilder

Constructs a fluent builder for the ListTargetsByRule operation.

• The fluent builder is configurable:
  • rule(impl Into<String>) / set_rule(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>):
    required: false
    

    The token returned by a previous call to retrieve the next set of results.

    
    
  • limit(i32) / set_limit(Option<i32>):
    required: false
    

    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>

impl Client

pub fn put_events(&self) -> PutEventsFluentBuilder

Constructs a fluent builder for the PutEvents operation.

• The fluent builder is configurable:
  • entries(PutEventsRequestEntry) / set_entries(Option<Vec::<PutEventsRequestEntry>>):
    required: true
    

    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>):
    required: false
    

    The URL subdomain of the endpoint. For example, if the URL for Endpoint is https://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.

    For each record, the index of the response element is the same as the index in the request array.

• On failure, responds with SdkError<PutEventsError>

impl Client

pub fn put_partner_events(&self) -> PutPartnerEventsFluentBuilder

Constructs a fluent builder for the PutPartnerEvents operation.

• The fluent builder is configurable:
  • entries(PutPartnerEventsRequestEntry) / set_entries(Option<Vec::<PutPartnerEventsRequestEntry>>):
    required: true
    

    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 results for each event entry the partner submitted in this request. If the event was successfully submitted, 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.

    For each record, the index of the response element is the same as the index in the request array.

• On failure, responds with SdkError<PutPartnerEventsError>

impl Client

pub fn put_permission(&self) -> PutPermissionFluentBuilder

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>):
    required: false
    

    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>):
    required: false
    

    The action that you are enabling the other account to perform.

    
    
  • principal(impl Into<String>) / set_principal(Option<String>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>):
    required: false
    

    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>

impl Client

pub fn put_rule(&self) -> PutRuleFluentBuilder

Constructs a fluent builder for the PutRule operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the rule that you are creating or updating.

    
    
  • schedule_expression(impl Into<String>) / set_schedule_expression(Option<String>):
    required: false
    

    The scheduling expression. For example, “cron(0 20 * * ? *)” or “rate(5 minutes)”.

    
    
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: false
    

    The event pattern. For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    
    
  • state(RuleState) / set_state(Option<RuleState>):
    required: false
    

    Indicates whether the rule is enabled or disabled.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description of the rule.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    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(Tag) / set_tags(Option<Vec::<Tag>>):
    required: false
    

    The list of key-value pairs to associate with the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn put_targets(&self) -> PutTargetsFluentBuilder

Constructs a fluent builder for the PutTargets operation.

• The fluent builder is configurable:
  • rule(impl Into<String>) / set_rule(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    
    
  • targets(Target) / set_targets(Option<Vec::<Target>>):
    required: true
    

    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>

impl Client

pub fn remove_permission(&self) -> RemovePermissionFluentBuilder

Constructs a fluent builder for the RemovePermission operation.

• The fluent builder is configurable:
  • statement_id(impl Into<String>) / set_statement_id(Option<String>):
    required: false
    

    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(Option<bool>):
    required: false
    

    Specifies whether to remove all permissions.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    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>

impl Client

pub fn remove_targets(&self) -> RemoveTargetsFluentBuilder

Constructs a fluent builder for the RemoveTargets operation.

• The fluent builder is configurable:
  • rule(impl Into<String>) / set_rule(Option<String>):
    required: true
    

    The name of the rule.

    
    
  • event_bus_name(impl Into<String>) / set_event_bus_name(Option<String>):
    required: false
    

    The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

    
    
  • ids(impl Into<String>) / set_ids(Option<Vec::<String>>):
    required: true
    

    The IDs of the targets to remove from the rule.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    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>

impl Client

pub fn start_replay(&self) -> StartReplayFluentBuilder

Constructs a fluent builder for the StartReplay operation.

• The fluent builder is configurable:
  • replay_name(impl Into<String>) / set_replay_name(Option<String>):
    required: true
    

    The name of the replay to start.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the replay to start.

    
    
  • event_source_arn(impl Into<String>) / set_event_source_arn(Option<String>):
    required: true
    

    The ARN of the archive to replay events from.

    
    
  • event_start_time(DateTime) / set_event_start_time(Option<DateTime>):
    required: true
    

    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>):
    required: true
    

    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>):
    required: true
    

    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>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the EventBridge resource that you’re adding tags to.

    
    
  • tags(Tag) / set_tags(Option<Vec::<Tag>>):
    required: true
    

    The list of key-value pairs to associate with the resource.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn test_event_pattern(&self) -> TestEventPatternFluentBuilder

Constructs a fluent builder for the TestEventPattern operation.

• The fluent builder is configurable:
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: true
    

    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>):
    required: true
    

    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>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The ARN of the EventBridge resource from which you are removing tags.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The list of tag keys to remove from the resource.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_api_destination(&self) -> UpdateApiDestinationFluentBuilder

Constructs a fluent builder for the UpdateApiDestination operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the API destination to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The name of the API destination to update.

    
    
  • connection_arn(impl Into<String>) / set_connection_arn(Option<String>):
    required: false
    

    The ARN of the connection to use for the API destination.

    
    
  • invocation_endpoint(impl Into<String>) / set_invocation_endpoint(Option<String>):
    required: false
    

    The URL to the endpoint to use for the API destination.

    
    
  • http_method(ApiDestinationHttpMethod) / set_http_method(Option<ApiDestinationHttpMethod>):
    required: false
    

    The method to use for the API destination.

    
    
  • invocation_rate_limit_per_second(i32) / set_invocation_rate_limit_per_second(Option<i32>):
    required: false
    

    The maximum number of invocations per second to send to the API destination.

    
    
• On success, responds with UpdateApiDestinationOutput with field(s):
  • api_destination_arn(Option<String>):

    The ARN of the API destination that was updated.

  • api_destination_state(Option<ApiDestinationState>):

    The state of the API destination that was updated.

  • 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<UpdateApiDestinationError>

impl Client

pub fn update_archive(&self) -> UpdateArchiveFluentBuilder

Constructs a fluent builder for the UpdateArchive operation.

• The fluent builder is configurable:
  • archive_name(impl Into<String>) / set_archive_name(Option<String>):
    required: true
    

    The name of the archive to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    The description for the archive.

    
    
  • event_pattern(impl Into<String>) / set_event_pattern(Option<String>):
    required: false
    

    The event pattern to use to filter events sent to the archive.

    
    
  • retention_days(i32) / set_retention_days(Option<i32>):
    required: false
    

    The number of days to retain events in the archive.

    
    
• On success, responds with UpdateArchiveOutput with field(s):
  • archive_arn(Option<String>):

    The ARN of the archive.

  • state(Option<ArchiveState>):

    The state of the archive.

  • state_reason(Option<String>):

    The reason that the archive is in the current state.

  • creation_time(Option<DateTime>):

    The time at which the archive was updated.

• On failure, responds with SdkError<UpdateArchiveError>

impl Client

pub fn update_connection(&self) -> UpdateConnectionFluentBuilder

Constructs a fluent builder for the UpdateConnection operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the connection to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the connection.

    
    
  • authorization_type(ConnectionAuthorizationType) / set_authorization_type(Option<ConnectionAuthorizationType>):
    required: false
    

    The type of authorization to use for the connection.

    
    
  • auth_parameters(UpdateConnectionAuthRequestParameters) / set_auth_parameters(Option<UpdateConnectionAuthRequestParameters>):
    required: false
    

    The authorization parameters to use for the connection.

    
    
• On success, responds with UpdateConnectionOutput with field(s):
  • connection_arn(Option<String>):

    The ARN of the connection that was updated.

  • connection_state(Option<ConnectionState>):

    The state of the connection that was updated.

  • 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<UpdateConnectionError>

impl Client

pub fn update_endpoint(&self) -> UpdateEndpointFluentBuilder

Constructs a fluent builder for the UpdateEndpoint operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the endpoint you want to update.

    
    
  • description(impl Into<String>) / set_description(Option<String>):
    required: false
    

    A description for the endpoint.

    
    
  • routing_config(RoutingConfig) / set_routing_config(Option<RoutingConfig>):
    required: false
    

    Configure the routing policy, including the health check and secondary Region.

    
    
  • replication_config(ReplicationConfig) / set_replication_config(Option<ReplicationConfig>):
    required: false
    

    Whether event replication was enabled or disabled by this request.

    
    
  • event_buses(EndpointEventBus) / set_event_buses(Option<Vec::<EndpointEventBus>>):
    required: false
    

    Define event buses used for replication.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The ARN of the role used by event replication for this request.

    
    
• On success, responds with UpdateEndpointOutput with field(s):
  • name(Option<String>):

    The name of the endpoint you updated in this request.

  • arn(Option<String>):

    The ARN of the endpoint you updated in this request.

  • routing_config(Option<RoutingConfig>):

    The routing configuration you updated in this request.

  • replication_config(Option<ReplicationConfig>):

    Whether event replication was enabled or disabled for the endpoint you updated in this request.

  • event_buses(Option<Vec::<EndpointEventBus>>):

    The event buses used for replication for the endpoint you updated in this request.

  • role_arn(Option<String>):

    The ARN of the role used by event replication for the endpoint you updated in this request.

  • endpoint_id(Option<String>):

    The ID of the endpoint you updated in this request.

  • endpoint_url(Option<String>):

    The URL of the endpoint you updated in this request.

  • state(Option<EndpointState>):

    The state of the endpoint you updated in this request.

• On failure, responds with SdkError<UpdateEndpointError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.