# Actions
<a name="API_Operations"></a>

The following actions are supported:
+  [ActivateEventSource](API_ActivateEventSource.md) 
+  [CancelReplay](API_CancelReplay.md) 
+  [CreateApiDestination](API_CreateApiDestination.md) 
+  [CreateArchive](API_CreateArchive.md) 
+  [CreateConnection](API_CreateConnection.md) 
+  [CreateEndpoint](API_CreateEndpoint.md) 
+  [CreateEventBus](API_CreateEventBus.md) 
+  [CreatePartnerEventSource](API_CreatePartnerEventSource.md) 
+  [DeactivateEventSource](API_DeactivateEventSource.md) 
+  [DeauthorizeConnection](API_DeauthorizeConnection.md) 
+  [DeleteApiDestination](API_DeleteApiDestination.md) 
+  [DeleteArchive](API_DeleteArchive.md) 
+  [DeleteConnection](API_DeleteConnection.md) 
+  [DeleteEndpoint](API_DeleteEndpoint.md) 
+  [DeleteEventBus](API_DeleteEventBus.md) 
+  [DeletePartnerEventSource](API_DeletePartnerEventSource.md) 
+  [DeleteRule](API_DeleteRule.md) 
+  [DescribeApiDestination](API_DescribeApiDestination.md) 
+  [DescribeArchive](API_DescribeArchive.md) 
+  [DescribeConnection](API_DescribeConnection.md) 
+  [DescribeEndpoint](API_DescribeEndpoint.md) 
+  [DescribeEventBus](API_DescribeEventBus.md) 
+  [DescribeEventSource](API_DescribeEventSource.md) 
+  [DescribePartnerEventSource](API_DescribePartnerEventSource.md) 
+  [DescribeReplay](API_DescribeReplay.md) 
+  [DescribeRule](API_DescribeRule.md) 
+  [DisableRule](API_DisableRule.md) 
+  [EnableRule](API_EnableRule.md) 
+  [ListApiDestinations](API_ListApiDestinations.md) 
+  [ListArchives](API_ListArchives.md) 
+  [ListConnections](API_ListConnections.md) 
+  [ListEndpoints](API_ListEndpoints.md) 
+  [ListEventBuses](API_ListEventBuses.md) 
+  [ListEventSources](API_ListEventSources.md) 
+  [ListPartnerEventSourceAccounts](API_ListPartnerEventSourceAccounts.md) 
+  [ListPartnerEventSources](API_ListPartnerEventSources.md) 
+  [ListReplays](API_ListReplays.md) 
+  [ListRuleNamesByTarget](API_ListRuleNamesByTarget.md) 
+  [ListRules](API_ListRules.md) 
+  [ListTagsForResource](API_ListTagsForResource.md) 
+  [ListTargetsByRule](API_ListTargetsByRule.md) 
+  [PutEvents](API_PutEvents.md) 
+  [PutPartnerEvents](API_PutPartnerEvents.md) 
+  [PutPermission](API_PutPermission.md) 
+  [PutRule](API_PutRule.md) 
+  [PutTargets](API_PutTargets.md) 
+  [RemovePermission](API_RemovePermission.md) 
+  [RemoveTargets](API_RemoveTargets.md) 
+  [StartReplay](API_StartReplay.md) 
+  [TagResource](API_TagResource.md) 
+  [TestEventPattern](API_TestEventPattern.md) 
+  [UntagResource](API_UntagResource.md) 
+  [UpdateApiDestination](API_UpdateApiDestination.md) 
+  [UpdateArchive](API_UpdateArchive.md) 
+  [UpdateConnection](API_UpdateConnection.md) 
+  [UpdateEndpoint](API_UpdateEndpoint.md) 
+  [UpdateEventBus](API_UpdateEventBus.md) 

# ActivateEventSource
<a name="API_ActivateEventSource"></a>

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

## Request Syntax
<a name="API_ActivateEventSource_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_ActivateEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_ActivateEventSource_RequestSyntax) **   <a name="eventbridge-ActivateEventSource-request-Name"></a>
The name of the partner event source to activate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Elements
<a name="API_ActivateEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_ActivateEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidStateException **   
The specified state is not a valid state for an event source.  
HTTP Status Code: 400

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_ActivateEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ActivateEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ActivateEventSource) 

# CancelReplay
<a name="API_CancelReplay"></a>

Cancels the specified replay.

## Request Syntax
<a name="API_CancelReplay_RequestSyntax"></a>

```
{
   "ReplayName": "string"
}
```

## Request Parameters
<a name="API_CancelReplay_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ReplayName](#API_CancelReplay_RequestSyntax) **   <a name="eventbridge-CancelReplay-request-ReplayName"></a>
The name of the replay to cancel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_CancelReplay_ResponseSyntax"></a>

```
{
   "ReplayArn": "string",
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_CancelReplay_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ReplayArn](#API_CancelReplay_ResponseSyntax) **   <a name="eventbridge-CancelReplay-response-ReplayArn"></a>
The ARN of the replay to cancel.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$` 

 ** [State](#API_CancelReplay_ResponseSyntax) **   <a name="eventbridge-CancelReplay-response-State"></a>
The current state of the replay.  
Type: String  
Valid Values: `STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED` 

 ** [StateReason](#API_CancelReplay_ResponseSyntax) **   <a name="eventbridge-CancelReplay-response-StateReason"></a>
The reason that the replay is in the current state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_CancelReplay_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** IllegalStatusException **   
An error occurred because a replay can be canceled only when the state is Running or Starting.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_CancelReplay_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CancelReplay) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CancelReplay) 

# CreateApiDestination
<a name="API_CreateApiDestination"></a>

Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see [API destinations](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html) in the *EventBridge User Guide*.

## Request Syntax
<a name="API_CreateApiDestination_RequestSyntax"></a>

```
{
   "ConnectionArn": "string",
   "Description": "string",
   "HttpMethod": "string",
   "InvocationEndpoint": "string",
   "InvocationRateLimitPerSecond": number,
   "Name": "string"
}
```

## Request Parameters
<a name="API_CreateApiDestination_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ConnectionArn](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-ConnectionArn"></a>
The ARN of the connection to use for the API destination. The destination endpoint must support the authorization type specified for the connection.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$`   
Required: Yes

 ** [Description](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-Description"></a>
A description for the API destination to create.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [HttpMethod](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-HttpMethod"></a>
The method to use for the request to the HTTP invocation endpoint.  
Type: String  
Valid Values: `POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE`   
Required: Yes

 ** [InvocationEndpoint](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-InvocationEndpoint"></a>
The URL to the HTTP invocation endpoint for the API destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$`   
Required: Yes

 ** [InvocationRateLimitPerSecond](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-InvocationRateLimitPerSecond"></a>
The maximum number of requests per second to send to the HTTP invocation endpoint.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Name](#API_CreateApiDestination_RequestSyntax) **   <a name="eventbridge-CreateApiDestination-request-Name"></a>
The name for the API destination to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_CreateApiDestination_ResponseSyntax"></a>

```
{
   "ApiDestinationArn": "string",
   "ApiDestinationState": "string",
   "CreationTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_CreateApiDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApiDestinationArn](#API_CreateApiDestination_ResponseSyntax) **   <a name="eventbridge-CreateApiDestination-response-ApiDestinationArn"></a>
The ARN of the API destination that was created by the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ApiDestinationState](#API_CreateApiDestination_ResponseSyntax) **   <a name="eventbridge-CreateApiDestination-response-ApiDestinationState"></a>
The state of the API destination that was created by the request.  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

 ** [CreationTime](#API_CreateApiDestination_ResponseSyntax) **   <a name="eventbridge-CreateApiDestination-response-CreationTime"></a>
A time stamp indicating the time that the API destination was created.  
Type: Timestamp

 ** [LastModifiedTime](#API_CreateApiDestination_ResponseSyntax) **   <a name="eventbridge-CreateApiDestination-response-LastModifiedTime"></a>
A time stamp indicating the time that the API destination was last modified.  
Type: Timestamp

## Errors
<a name="API_CreateApiDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_CreateApiDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreateApiDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreateApiDestination) 

# CreateArchive
<a name="API_CreateArchive"></a>

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

**Important**  
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.   
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.

## Request Syntax
<a name="API_CreateArchive_RequestSyntax"></a>

```
{
   "ArchiveName": "string",
   "Description": "string",
   "EventPattern": "string",
   "EventSourceArn": "string",
   "KmsKeyIdentifier": "string",
   "RetentionDays": number
}
```

## Request Parameters
<a name="API_CreateArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ArchiveName](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-ArchiveName"></a>
The name for the archive to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [Description](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-Description"></a>
A description for the archive.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [EventPattern](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-EventPattern"></a>
An event pattern to use to filter events sent to the archive.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: No

 ** [EventSourceArn](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-EventSourceArn"></a>
The ARN of the event bus that sends events to the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$`   
Required: Yes

 ** [KmsKeyIdentifier](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the archive.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.   
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [RetentionDays](#API_CreateArchive_RequestSyntax) **   <a name="eventbridge-CreateArchive-request-RetentionDays"></a>
The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## Response Syntax
<a name="API_CreateArchive_ResponseSyntax"></a>

```
{
   "ArchiveArn": "string",
   "CreationTime": number,
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_CreateArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ArchiveArn](#API_CreateArchive_ResponseSyntax) **   <a name="eventbridge-CreateArchive-response-ArchiveArn"></a>
The ARN of the archive that was created.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$` 

 ** [CreationTime](#API_CreateArchive_ResponseSyntax) **   <a name="eventbridge-CreateArchive-response-CreationTime"></a>
The time at which the archive was created.  
Type: Timestamp

 ** [State](#API_CreateArchive_ResponseSyntax) **   <a name="eventbridge-CreateArchive-response-State"></a>
The state of the archive that was created.  
Type: String  
Valid Values: `ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED` 

 ** [StateReason](#API_CreateArchive_ResponseSyntax) **   <a name="eventbridge-CreateArchive-response-StateReason"></a>
The reason that the archive is in the state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_CreateArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidEventPatternException **   
The event pattern is not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_CreateArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreateArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreateArchive) 

# CreateConnection
<a name="API_CreateConnection"></a>

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

For more information, see [Connections for endpoint targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-target-connection.html) in the *Amazon EventBridge User Guide*.

## Request Syntax
<a name="API_CreateConnection_RequestSyntax"></a>

```
{
   "AuthorizationType": "string",
   "AuthParameters": { 
      "ApiKeyAuthParameters": { 
         "ApiKeyName": "string",
         "ApiKeyValue": "string"
      },
      "BasicAuthParameters": { 
         "Password": "string",
         "Username": "string"
      },
      "ConnectivityParameters": { 
         "ResourceParameters": { 
            "ResourceConfigurationArn": "string"
         }
      },
      "InvocationHttpParameters": { 
         "BodyParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "HeaderParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "QueryStringParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "OAuthParameters": { 
         "AuthorizationEndpoint": "string",
         "ClientParameters": { 
            "ClientID": "string",
            "ClientSecret": "string"
         },
         "HttpMethod": "string",
         "OAuthHttpParameters": { 
            "BodyParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "HeaderParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "QueryStringParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ]
         }
      }
   },
   "Description": "string",
   "InvocationConnectivityParameters": { 
      "ResourceParameters": { 
         "ResourceConfigurationArn": "string"
      }
   },
   "KmsKeyIdentifier": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_CreateConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuthorizationType](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-AuthorizationType"></a>
The type of authorization to use for the connection.  
OAUTH tokens are refreshed when a 401 or 407 response is returned.
Type: String  
Valid Values: `BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY`   
Required: Yes

 ** [AuthParameters](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-AuthParameters"></a>
The authorization parameters to use to authorize with the endpoint.   
You must include only authorization parameters for the `AuthorizationType` you specify.  
Type: [CreateConnectionAuthRequestParameters](API_CreateConnectionAuthRequestParameters.md) object  
Required: Yes

 ** [Description](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-Description"></a>
A description for the connection to create.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [InvocationConnectivityParameters](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-InvocationConnectivityParameters"></a>
For connections to private APIs, the parameters to use for invoking the API.  
For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the * *Amazon EventBridge User Guide* *.  
Type: [ConnectivityResourceParameters](API_ConnectivityResourceParameters.md) object  
Required: No

 ** [KmsKeyIdentifier](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [Name](#API_CreateConnection_RequestSyntax) **   <a name="eventbridge-CreateConnection-request-Name"></a>
The name for the connection to create.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_CreateConnection_ResponseSyntax"></a>

```
{
   "ConnectionArn": "string",
   "ConnectionState": "string",
   "CreationTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_CreateConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionArn](#API_CreateConnection_ResponseSyntax) **   <a name="eventbridge-CreateConnection-response-ConnectionArn"></a>
The ARN of the connection that was created by the request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ConnectionState](#API_CreateConnection_ResponseSyntax) **   <a name="eventbridge-CreateConnection-response-ConnectionState"></a>
The state of the connection that was created by the request.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY` 

 ** [CreationTime](#API_CreateConnection_ResponseSyntax) **   <a name="eventbridge-CreateConnection-response-CreationTime"></a>
A time stamp for the time that the connection was created.  
Type: Timestamp

 ** [LastModifiedTime](#API_CreateConnection_ResponseSyntax) **   <a name="eventbridge-CreateConnection-response-LastModifiedTime"></a>
A time stamp for the time that the connection was last updated.  
Type: Timestamp

## Errors
<a name="API_CreateConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions for this action.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
This request cannot be completed due to throttling issues.  
HTTP Status Code: 400

## See Also
<a name="API_CreateConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreateConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreateConnection) 

# CreateEndpoint
<a name="API_CreateEndpoint"></a>

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

## Request Syntax
<a name="API_CreateEndpoint_RequestSyntax"></a>

```
{
   "Description": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   }
}
```

## Request Parameters
<a name="API_CreateEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-Description"></a>
A description of the global endpoint.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [EventBuses](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-EventBuses"></a>
Define the event buses used.   
The names of the event buses must be identical in each Region.
Type: Array of [EndpointEventBus](API_EndpointEventBus.md) objects  
Array Members: Fixed number of 2 items.  
Required: Yes

 ** [Name](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-Name"></a>
The name of the global endpoint. For example, `"Name":"us-east-2-custom_bus_A-endpoint"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [ReplicationConfig](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-ReplicationConfig"></a>
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`.  
Type: [ReplicationConfig](API_ReplicationConfig.md) object  
Required: No

 ** [RoleArn](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-RoleArn"></a>
The ARN of the role used for replication.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$`   
Required: No

 ** [RoutingConfig](#API_CreateEndpoint_RequestSyntax) **   <a name="eventbridge-CreateEndpoint-request-RoutingConfig"></a>
Configure the routing policy, including the health check and secondary Region..  
Type: [RoutingConfig](API_RoutingConfig.md) object  
Required: Yes

## Response Syntax
<a name="API_CreateEndpoint_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string"
}
```

## Response Elements
<a name="API_CreateEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-Arn"></a>
The ARN of the endpoint that was created by this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$` 

 ** [EventBuses](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-EventBuses"></a>
The event buses used by this request.  
Type: Array of [EndpointEventBus](API_EndpointEventBus.md) objects  
Array Members: Fixed number of 2 items.

 ** [Name](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-Name"></a>
The name of the endpoint that was created by this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [ReplicationConfig](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-ReplicationConfig"></a>
Whether event replication was enabled or disabled by this request.  
Type: [ReplicationConfig](API_ReplicationConfig.md) object

 ** [RoleArn](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-RoleArn"></a>
The ARN of the role used by event replication for this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$` 

 ** [RoutingConfig](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-RoutingConfig"></a>
The routing configuration defined by this request.  
Type: [RoutingConfig](API_RoutingConfig.md) object

 ** [State](#API_CreateEndpoint_ResponseSyntax) **   <a name="eventbridge-CreateEndpoint-response-State"></a>
The state of the endpoint that was created by this request.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED` 

## Errors
<a name="API_CreateEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreateEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreateEndpoint) 

# CreateEventBus
<a name="API_CreateEventBus"></a>

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

## Request Syntax
<a name="API_CreateEventBus_RequestSyntax"></a>

```
{
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "EventSourceName": "string",
   "KmsKeyIdentifier": "string",
   "LogConfig": { 
      "IncludeDetail": "string",
      "Level": "string"
   },
   "Name": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_CreateEventBus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeadLetterConfig](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-DeadLetterConfig"></a>
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).  
For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide*.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object  
Required: No

 ** [Description](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-Description"></a>
The event bus description.  
Type: String  
Length Constraints: Maximum length of 512.  
Required: No

 ** [EventSourceName](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-EventSourceName"></a>
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: No

 ** [KmsKeyIdentifier](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:   
+ You call ` [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) ` on an event bus set to use a customer managed key for encryption.
+ You call ` [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) ` to set a customer managed key on an event bus with schema discovery enabled.
To enable schema discovery on an event bus, choose to use an AWS owned key. For more information, see [Encrypting events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption-event-bus-cmkey.html) in the *Amazon EventBridge User Guide*.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.   
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [LogConfig](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-LogConfig"></a>
The logging configuration settings for the event bus.  
For more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) in the *EventBridge User Guide*.  
Type: [LogConfig](API_LogConfig.md) object  
Required: No

 ** [Name](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-Name"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [Tags](#API_CreateEventBus_RequestSyntax) **   <a name="eventbridge-CreateEventBus-request-Tags"></a>
Tags to associate with the event bus.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_CreateEventBus_ResponseSyntax"></a>

```
{
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "EventBusArn": "string",
   "KmsKeyIdentifier": "string",
   "LogConfig": { 
      "IncludeDetail": "string",
      "Level": "string"
   }
}
```

## Response Elements
<a name="API_CreateEventBus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [DeadLetterConfig](#API_CreateEventBus_ResponseSyntax) **   <a name="eventbridge-CreateEventBus-response-DeadLetterConfig"></a>
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).  
For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide*.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object

 ** [Description](#API_CreateEventBus_ResponseSyntax) **   <a name="eventbridge-CreateEventBus-response-Description"></a>
The event bus description.  
Type: String  
Length Constraints: Maximum length of 512.

 ** [EventBusArn](#API_CreateEventBus_ResponseSyntax) **   <a name="eventbridge-CreateEventBus-response-EventBusArn"></a>
The ARN of the new event bus.  
Type: String

 ** [KmsKeyIdentifier](#API_CreateEventBus_ResponseSyntax) **   <a name="eventbridge-CreateEventBus-response-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.  
For more information, see [Data encryption in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html) in the *Amazon EventBridge User Guide*.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$` 

 ** [LogConfig](#API_CreateEventBus_ResponseSyntax) **   <a name="eventbridge-CreateEventBus-response-LogConfig"></a>
The logging configuration settings for the event bus.  
For more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) in the *EventBridge User Guide*.  
Type: [LogConfig](API_LogConfig.md) object

## Errors
<a name="API_CreateEventBus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidStateException **   
The specified state is not a valid state for an event source.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_CreateEventBus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreateEventBus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreateEventBus) 

# CreatePartnerEventSource
<a name="API_CreatePartnerEventSource"></a>

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

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

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

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

Partner event source names follow this format:

 ` partner_name/event_namespace/event_name ` 
+  *partner\$1name* is determined during partner registration, and identifies the partner to AWS customers. 
+  *event\$1namespace* is determined by the partner, and is a way for the partner to categorize their events.
+  *event\$1name* is determined by the partner, and should uniquely identify an event-generating resource within the partner system. 

  The *event\$1name* must be unique across all AWS customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.

The combination of *event\$1namespace* and *event\$1name* should help AWS customers decide whether to create an event bus to receive these events.

## Request Syntax
<a name="API_CreatePartnerEventSource_RequestSyntax"></a>

```
{
   "Account": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_CreatePartnerEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Account](#API_CreatePartnerEventSource_RequestSyntax) **   <a name="eventbridge-CreatePartnerEventSource-request-Account"></a>
The AWS account ID that is permitted to create a matching partner event bus for this partner event source.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [Name](#API_CreatePartnerEventSource_RequestSyntax) **   <a name="eventbridge-CreatePartnerEventSource-request-Name"></a>
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 AWS 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Syntax
<a name="API_CreatePartnerEventSource_ResponseSyntax"></a>

```
{
   "EventSourceArn": "string"
}
```

## Response Elements
<a name="API_CreatePartnerEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventSourceArn](#API_CreatePartnerEventSource_ResponseSyntax) **   <a name="eventbridge-CreatePartnerEventSource-response-EventSourceArn"></a>
The ARN of the partner event source.  
Type: String

## Errors
<a name="API_CreatePartnerEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

## See Also
<a name="API_CreatePartnerEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/CreatePartnerEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/CreatePartnerEventSource) 

# DeactivateEventSource
<a name="API_DeactivateEventSource"></a>

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted. 

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use [ActivateEventSource](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ActivateEventSource.html).

## Request Syntax
<a name="API_DeactivateEventSource_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeactivateEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeactivateEventSource_RequestSyntax) **   <a name="eventbridge-DeactivateEventSource-request-Name"></a>
The name of the partner event source to deactivate.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Elements
<a name="API_DeactivateEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeactivateEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidStateException **   
The specified state is not a valid state for an event source.  
HTTP Status Code: 400

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeactivateEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeactivateEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeactivateEventSource) 

# DeauthorizeConnection
<a name="API_DeauthorizeConnection"></a>

Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.

## Request Syntax
<a name="API_DeauthorizeConnection_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeauthorizeConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeauthorizeConnection_RequestSyntax) **   <a name="eventbridge-DeauthorizeConnection-request-Name"></a>
The name of the connection to remove authorization from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DeauthorizeConnection_ResponseSyntax"></a>

```
{
   "ConnectionArn": "string",
   "ConnectionState": "string",
   "CreationTime": number,
   "LastAuthorizedTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_DeauthorizeConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionArn](#API_DeauthorizeConnection_ResponseSyntax) **   <a name="eventbridge-DeauthorizeConnection-response-ConnectionArn"></a>
The ARN of the connection that authorization was removed from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ConnectionState](#API_DeauthorizeConnection_ResponseSyntax) **   <a name="eventbridge-DeauthorizeConnection-response-ConnectionState"></a>
The state of the connection.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY` 

 ** [CreationTime](#API_DeauthorizeConnection_ResponseSyntax) **   <a name="eventbridge-DeauthorizeConnection-response-CreationTime"></a>
A time stamp for the time that the connection was created.  
Type: Timestamp

 ** [LastAuthorizedTime](#API_DeauthorizeConnection_ResponseSyntax) **   <a name="eventbridge-DeauthorizeConnection-response-LastAuthorizedTime"></a>
A time stamp for the time that the connection was last authorized.  
Type: Timestamp

 ** [LastModifiedTime](#API_DeauthorizeConnection_ResponseSyntax) **   <a name="eventbridge-DeauthorizeConnection-response-LastModifiedTime"></a>
A time stamp for the time that the connection was last updated.  
Type: Timestamp

## Errors
<a name="API_DeauthorizeConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeauthorizeConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeauthorizeConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeauthorizeConnection) 

# DeleteApiDestination
<a name="API_DeleteApiDestination"></a>

Deletes the specified API destination.

## Request Syntax
<a name="API_DeleteApiDestination_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteApiDestination_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteApiDestination_RequestSyntax) **   <a name="eventbridge-DeleteApiDestination-request-Name"></a>
The name of the destination to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DeleteApiDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteApiDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteApiDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteApiDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteApiDestination) 

# DeleteArchive
<a name="API_DeleteArchive"></a>

Deletes the specified archive.

## Request Syntax
<a name="API_DeleteArchive_RequestSyntax"></a>

```
{
   "ArchiveName": "string"
}
```

## Request Parameters
<a name="API_DeleteArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ArchiveName](#API_DeleteArchive_RequestSyntax) **   <a name="eventbridge-DeleteArchive-request-ArchiveName"></a>
The name of the archive to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DeleteArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteArchive) 

# DeleteConnection
<a name="API_DeleteConnection"></a>

Deletes a connection.

## Request Syntax
<a name="API_DeleteConnection_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteConnection_RequestSyntax) **   <a name="eventbridge-DeleteConnection-request-Name"></a>
The name of the connection to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DeleteConnection_ResponseSyntax"></a>

```
{
   "ConnectionArn": "string",
   "ConnectionState": "string",
   "CreationTime": number,
   "LastAuthorizedTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_DeleteConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionArn](#API_DeleteConnection_ResponseSyntax) **   <a name="eventbridge-DeleteConnection-response-ConnectionArn"></a>
The ARN of the connection that was deleted.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ConnectionState](#API_DeleteConnection_ResponseSyntax) **   <a name="eventbridge-DeleteConnection-response-ConnectionState"></a>
The state of the connection before it was deleted.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY` 

 ** [CreationTime](#API_DeleteConnection_ResponseSyntax) **   <a name="eventbridge-DeleteConnection-response-CreationTime"></a>
A time stamp for the time that the connection was created.  
Type: Timestamp

 ** [LastAuthorizedTime](#API_DeleteConnection_ResponseSyntax) **   <a name="eventbridge-DeleteConnection-response-LastAuthorizedTime"></a>
A time stamp for the time that the connection was last authorized before it wa deleted.  
Type: Timestamp

 ** [LastModifiedTime](#API_DeleteConnection_ResponseSyntax) **   <a name="eventbridge-DeleteConnection-response-LastModifiedTime"></a>
A time stamp for the time that the connection was last modified before it was deleted.  
Type: Timestamp

## Errors
<a name="API_DeleteConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteConnection) 

# DeleteEndpoint
<a name="API_DeleteEndpoint"></a>

Delete an existing global endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the * *Amazon EventBridge User Guide* *.

## Request Syntax
<a name="API_DeleteEndpoint_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteEndpoint_RequestSyntax) **   <a name="eventbridge-DeleteEndpoint-request-Name"></a>
The name of the endpoint you want to delete. For example, `"Name":"us-east-2-custom_bus_A-endpoint"`..  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DeleteEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DeleteEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteEndpoint) 

# DeleteEventBus
<a name="API_DeleteEventBus"></a>

Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.

## Request Syntax
<a name="API_DeleteEventBus_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteEventBus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DeleteEventBus_RequestSyntax) **   <a name="eventbridge-DeleteEventBus-request-Name"></a>
The name of the event bus to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DeleteEventBus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteEventBus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_DeleteEventBus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteEventBus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteEventBus) 

# DeletePartnerEventSource
<a name="API_DeletePartnerEventSource"></a>

This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.

When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.



## Request Syntax
<a name="API_DeletePartnerEventSource_RequestSyntax"></a>

```
{
   "Account": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeletePartnerEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Account](#API_DeletePartnerEventSource_RequestSyntax) **   <a name="eventbridge-DeletePartnerEventSource-request-Account"></a>
The AWS account ID of the AWS customer that the event source was created for.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `\d{12}`   
Required: Yes

 ** [Name](#API_DeletePartnerEventSource_RequestSyntax) **   <a name="eventbridge-DeletePartnerEventSource-request-Name"></a>
The name of the event source to delete.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Elements
<a name="API_DeletePartnerEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeletePartnerEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

## See Also
<a name="API_DeletePartnerEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeletePartnerEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeletePartnerEventSource) 

# DeleteRule
<a name="API_DeleteRule"></a>

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using [RemoveTargets](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemoveTargets.html).

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

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

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

## Request Syntax
<a name="API_DeleteRule_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Force": boolean,
   "Name": "string"
}
```

## Request Parameters
<a name="API_DeleteRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_DeleteRule_RequestSyntax) **   <a name="eventbridge-DeleteRule-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Force](#API_DeleteRule_RequestSyntax) **   <a name="eventbridge-DeleteRule-request-Force"></a>
If this is a managed rule, created by an AWS 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.  
Type: Boolean  
Required: No

 ** [Name](#API_DeleteRule_RequestSyntax) **   <a name="eventbridge-DeleteRule-request-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DeleteRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DeleteRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_DeleteRule_Examples"></a>

### Deletes a rule named "test"
<a name="API_DeleteRule_Example_1"></a>

The following is an example of a DeleteRule request.

#### Sample Request
<a name="API_DeleteRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.DeleteRule

{
    "Name": "test"
}
```

#### Sample Response
<a name="API_DeleteRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
```

## See Also
<a name="API_DeleteRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DeleteRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DeleteRule) 

# DescribeApiDestination
<a name="API_DescribeApiDestination"></a>

Retrieves details about an API destination.

## Request Syntax
<a name="API_DescribeApiDestination_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeApiDestination_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DescribeApiDestination_RequestSyntax) **   <a name="eventbridge-DescribeApiDestination-request-Name"></a>
The name of the API destination to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeApiDestination_ResponseSyntax"></a>

```
{
   "ApiDestinationArn": "string",
   "ApiDestinationState": "string",
   "ConnectionArn": "string",
   "CreationTime": number,
   "Description": "string",
   "HttpMethod": "string",
   "InvocationEndpoint": "string",
   "InvocationRateLimitPerSecond": number,
   "LastModifiedTime": number,
   "Name": "string"
}
```

## Response Elements
<a name="API_DescribeApiDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApiDestinationArn](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-ApiDestinationArn"></a>
The ARN of the API destination retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ApiDestinationState](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-ApiDestinationState"></a>
The state of the API destination retrieved.  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

 ** [ConnectionArn](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-ConnectionArn"></a>
The ARN of the connection specified for the API destination retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [CreationTime](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-CreationTime"></a>
A time stamp for the time that the API destination was created.  
Type: Timestamp

 ** [Description](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-Description"></a>
The description for the API destination retrieved.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

 ** [HttpMethod](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-HttpMethod"></a>
The method to use to connect to the HTTP endpoint.  
Type: String  
Valid Values: `POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE` 

 ** [InvocationEndpoint](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-InvocationEndpoint"></a>
The URL to use to connect to the HTTP endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$` 

 ** [InvocationRateLimitPerSecond](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-InvocationRateLimitPerSecond"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1.

 ** [LastModifiedTime](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-LastModifiedTime"></a>
A time stamp for the time that the API destination was last modified.  
Type: Timestamp

 ** [Name](#API_DescribeApiDestination_ResponseSyntax) **   <a name="eventbridge-DescribeApiDestination-response-Name"></a>
The name of the API destination retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

## Errors
<a name="API_DescribeApiDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeApiDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeApiDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeApiDestination) 

# DescribeArchive
<a name="API_DescribeArchive"></a>

Retrieves details about an archive.

## Request Syntax
<a name="API_DescribeArchive_RequestSyntax"></a>

```
{
   "ArchiveName": "string"
}
```

## Request Parameters
<a name="API_DescribeArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ArchiveName](#API_DescribeArchive_RequestSyntax) **   <a name="eventbridge-DescribeArchive-request-ArchiveName"></a>
The name of the archive to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeArchive_ResponseSyntax"></a>

```
{
   "ArchiveArn": "string",
   "ArchiveName": "string",
   "CreationTime": number,
   "Description": "string",
   "EventCount": number,
   "EventPattern": "string",
   "EventSourceArn": "string",
   "KmsKeyIdentifier": "string",
   "RetentionDays": number,
   "SizeBytes": number,
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_DescribeArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ArchiveArn](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-ArchiveArn"></a>
The ARN of the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$` 

 ** [ArchiveName](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-ArchiveName"></a>
The name of the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [CreationTime](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-CreationTime"></a>
The time at which the archive was created.  
Type: Timestamp

 ** [Description](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-Description"></a>
The description of the archive.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

 ** [EventCount](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-EventCount"></a>
The number of events in the archive.  
Type: Long

 ** [EventPattern](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-EventPattern"></a>
The event pattern used to filter events sent to the archive.  
Type: String  
Length Constraints: Maximum length of 4096.

 ** [EventSourceArn](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-EventSourceArn"></a>
The ARN of the event source associated with the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$` 

 ** [KmsKeyIdentifier](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt this archive, if one has been specified.  
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$` 

 ** [RetentionDays](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-RetentionDays"></a>
The number of days to retain events for in the archive.  
Type: Integer  
Valid Range: Minimum value of 0.

 ** [SizeBytes](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-SizeBytes"></a>
The size of the archive in bytes.  
Type: Long

 ** [State](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-State"></a>
The state of the archive.  
Type: String  
Valid Values: `ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED` 

 ** [StateReason](#API_DescribeArchive_ResponseSyntax) **   <a name="eventbridge-DescribeArchive-response-StateReason"></a>
The reason that the archive is in the state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_DescribeArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeArchive) 

# DescribeConnection
<a name="API_DescribeConnection"></a>

Retrieves details about a connection.

## Request Syntax
<a name="API_DescribeConnection_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DescribeConnection_RequestSyntax) **   <a name="eventbridge-DescribeConnection-request-Name"></a>
The name of the connection to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeConnection_ResponseSyntax"></a>

```
{
   "AuthorizationType": "string",
   "AuthParameters": { 
      "ApiKeyAuthParameters": { 
         "ApiKeyName": "string"
      },
      "BasicAuthParameters": { 
         "Username": "string"
      },
      "ConnectivityParameters": { 
         "ResourceParameters": { 
            "ResourceAssociationArn": "string",
            "ResourceConfigurationArn": "string"
         }
      },
      "InvocationHttpParameters": { 
         "BodyParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "HeaderParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "QueryStringParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "OAuthParameters": { 
         "AuthorizationEndpoint": "string",
         "ClientParameters": { 
            "ClientID": "string"
         },
         "HttpMethod": "string",
         "OAuthHttpParameters": { 
            "BodyParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "HeaderParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "QueryStringParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ]
         }
      }
   },
   "ConnectionArn": "string",
   "ConnectionState": "string",
   "CreationTime": number,
   "Description": "string",
   "InvocationConnectivityParameters": { 
      "ResourceParameters": { 
         "ResourceAssociationArn": "string",
         "ResourceConfigurationArn": "string"
      }
   },
   "KmsKeyIdentifier": "string",
   "LastAuthorizedTime": number,
   "LastModifiedTime": number,
   "Name": "string",
   "SecretArn": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_DescribeConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AuthorizationType](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-AuthorizationType"></a>
The type of authorization specified for the connection.  
Type: String  
Valid Values: `BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY` 

 ** [AuthParameters](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-AuthParameters"></a>
The parameters to use for authorization for the connection.  
Type: [ConnectionAuthResponseParameters](API_ConnectionAuthResponseParameters.md) object

 ** [ConnectionArn](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-ConnectionArn"></a>
The ARN of the connection retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ConnectionState](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-ConnectionState"></a>
The state of the connection retrieved.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY` 

 ** [CreationTime](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-CreationTime"></a>
A time stamp for the time that the connection was created.  
Type: Timestamp

 ** [Description](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-Description"></a>
The description for the connection retrieved.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

 ** [InvocationConnectivityParameters](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-InvocationConnectivityParameters"></a>
For connections to private APIs The parameters EventBridge uses to invoke the resource endpoint.  
For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the * *Amazon EventBridge User Guide* *.  
Type: [DescribeConnectionConnectivityParameters](API_DescribeConnectionConnectivityParameters.md) object

 ** [KmsKeyIdentifier](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified.  
For more information, see [Encrypting connections](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-connections.html) in the *Amazon EventBridge User Guide*.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$` 

 ** [LastAuthorizedTime](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-LastAuthorizedTime"></a>
A time stamp for the time that the connection was last authorized.  
Type: Timestamp

 ** [LastModifiedTime](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-LastModifiedTime"></a>
A time stamp for the time that the connection was last modified.  
Type: Timestamp

 ** [Name](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-Name"></a>
The name of the connection retrieved.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [SecretArn](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-SecretArn"></a>
The ARN of the secret created from the authorization parameters specified for the connection.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `^arn:aws([a-z]|\-)*:secretsmanager:([a-z]|\d|\-)*:([0-9]{12})?:secret:[\/_+=\.@\-A-Za-z0-9]+$` 

 ** [StateReason](#API_DescribeConnection_ResponseSyntax) **   <a name="eventbridge-DescribeConnection-response-StateReason"></a>
The reason that the connection is in the current connection state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_DescribeConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeConnection) 

# DescribeEndpoint
<a name="API_DescribeEndpoint"></a>

Get the information about an existing global endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the * *Amazon EventBridge User Guide* *.

## Request Syntax
<a name="API_DescribeEndpoint_RequestSyntax"></a>

```
{
   "HomeRegion": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HomeRegion](#API_DescribeEndpoint_RequestSyntax) **   <a name="eventbridge-DescribeEndpoint-request-HomeRegion"></a>
The primary Region of the endpoint you want to get information about. For example `"HomeRegion": "us-east-1"`.  
Type: String  
Length Constraints: Minimum length of 9. Maximum length of 20.  
Pattern: `^[\-a-z0-9]+$`   
Required: No

 ** [Name](#API_DescribeEndpoint_RequestSyntax) **   <a name="eventbridge-DescribeEndpoint-request-Name"></a>
The name of the endpoint you want to get information about. For example, `"Name":"us-east-2-custom_bus_A-endpoint"`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeEndpoint_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "CreationTime": number,
   "Description": "string",
   "EndpointId": "string",
   "EndpointUrl": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "LastModifiedTime": number,
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_DescribeEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-Arn"></a>
The ARN of the endpoint you asked for information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$` 

 ** [CreationTime](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-CreationTime"></a>
The time the endpoint you asked for information about was created.  
Type: Timestamp

 ** [Description](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-Description"></a>
The description of the endpoint you asked for information about.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

 ** [EndpointId](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-EndpointId"></a>
The ID of the endpoint you asked for information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$` 

 ** [EndpointUrl](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-EndpointUrl"></a>
The URL of the endpoint you asked for information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(https://)?[\.\-a-z0-9]+$` 

 ** [EventBuses](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-EventBuses"></a>
The event buses being used by the endpoint you asked for information about.  
Type: Array of [EndpointEventBus](API_EndpointEventBus.md) objects  
Array Members: Fixed number of 2 items.

 ** [LastModifiedTime](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-LastModifiedTime"></a>
The last time the endpoint you asked for information about was modified.  
Type: Timestamp

 ** [Name](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-Name"></a>
The name of the endpoint you asked for information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [ReplicationConfig](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-ReplicationConfig"></a>
Whether replication is enabled or disabled for the endpoint you asked for information about.  
Type: [ReplicationConfig](API_ReplicationConfig.md) object

 ** [RoleArn](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-RoleArn"></a>
The ARN of the role used by the endpoint you asked for information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$` 

 ** [RoutingConfig](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-RoutingConfig"></a>
The routing configuration of the endpoint you asked for information about.  
Type: [RoutingConfig](API_RoutingConfig.md) object

 ** [State](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-State"></a>
The current state of the endpoint you asked for information about.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED` 

 ** [StateReason](#API_DescribeEndpoint_ResponseSyntax) **   <a name="eventbridge-DescribeEndpoint-response-StateReason"></a>
The reason the endpoint you asked for information about is in its current state.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_DescribeEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeEndpoint) 

# DescribeEventBus
<a name="API_DescribeEventBus"></a>

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

 To enable your account to receive events from other accounts on its default event bus, use [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html).

For more information about partner event buses, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

## Request Syntax
<a name="API_DescribeEventBus_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeEventBus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DescribeEventBus_RequestSyntax) **   <a name="eventbridge-DescribeEventBus-request-Name"></a>
The name or ARN of the event bus to show details for. If you omit this, the default event bus is displayed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

## Response Syntax
<a name="API_DescribeEventBus_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "CreationTime": number,
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "KmsKeyIdentifier": "string",
   "LastModifiedTime": number,
   "LogConfig": { 
      "IncludeDetail": "string",
      "Level": "string"
   },
   "Name": "string",
   "Policy": "string"
}
```

## Response Elements
<a name="API_DescribeEventBus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-Arn"></a>
The Amazon Resource Name (ARN) of the account permitted to write events to the current account.  
Type: String

 ** [CreationTime](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-CreationTime"></a>
The time the event bus was created.  
Type: Timestamp

 ** [DeadLetterConfig](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-DeadLetterConfig"></a>
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).  
For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide*.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object

 ** [Description](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-Description"></a>
The event bus description.  
Type: String  
Length Constraints: Maximum length of 512.

 ** [KmsKeyIdentifier](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.  
For more information, see [Data encryption in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html) in the *Amazon EventBridge User Guide*.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$` 

 ** [LastModifiedTime](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-LastModifiedTime"></a>
The time the event bus was last modified.  
Type: Timestamp

 ** [LogConfig](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-LogConfig"></a>
The logging configuration settings for the event bus.  
For more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) in the *EventBridge User Guide*.  
Type: [LogConfig](API_LogConfig.md) object

 ** [Name](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-Name"></a>
The name of the event bus. Currently, this is always `default`.  
Type: String

 ** [Policy](#API_DescribeEventBus_ResponseSyntax) **   <a name="eventbridge-DescribeEventBus-response-Policy"></a>
The policy that enables the external account to send events to your account.  
Type: String

## Errors
<a name="API_DescribeEventBus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeEventBus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeEventBus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeEventBus) 

# DescribeEventSource
<a name="API_DescribeEventSource"></a>

This operation lists details about a partner event source that is shared with your account.

## Request Syntax
<a name="API_DescribeEventSource_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DescribeEventSource_RequestSyntax) **   <a name="eventbridge-DescribeEventSource-request-Name"></a>
The name of the partner event source to display the details of.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Syntax
<a name="API_DescribeEventSource_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "CreatedBy": "string",
   "CreationTime": number,
   "ExpirationTime": number,
   "Name": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_DescribeEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-Arn"></a>
The ARN of the partner event source.  
Type: String

 ** [CreatedBy](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-CreatedBy"></a>
The name of the SaaS partner that created the event source.  
Type: String

 ** [CreationTime](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-CreationTime"></a>
The date and time that the event source was created.  
Type: Timestamp

 ** [ExpirationTime](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-ExpirationTime"></a>
The date and time that the event source will expire if you do not create a matching event bus.  
Type: Timestamp

 ** [Name](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-Name"></a>
The name of the partner event source.  
Type: String

 ** [State](#API_DescribeEventSource_ResponseSyntax) **   <a name="eventbridge-DescribeEventSource-response-State"></a>
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.  
Type: String  
Valid Values: `PENDING | ACTIVE | DELETED` 

## Errors
<a name="API_DescribeEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeEventSource) 

# DescribePartnerEventSource
<a name="API_DescribePartnerEventSource"></a>

An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use [DescribeEventSource](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventSource.html) to see details about a partner event source that is shared with them.

## Request Syntax
<a name="API_DescribePartnerEventSource_RequestSyntax"></a>

```
{
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribePartnerEventSource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Name](#API_DescribePartnerEventSource_RequestSyntax) **   <a name="eventbridge-DescribePartnerEventSource-request-Name"></a>
The name of the event source to display.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

## Response Syntax
<a name="API_DescribePartnerEventSource_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "Name": "string"
}
```

## Response Elements
<a name="API_DescribePartnerEventSource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribePartnerEventSource_ResponseSyntax) **   <a name="eventbridge-DescribePartnerEventSource-response-Arn"></a>
The ARN of the event source.  
Type: String

 ** [Name](#API_DescribePartnerEventSource_ResponseSyntax) **   <a name="eventbridge-DescribePartnerEventSource-response-Name"></a>
The name of the event source.  
Type: String

## Errors
<a name="API_DescribePartnerEventSource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribePartnerEventSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribePartnerEventSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribePartnerEventSource) 

# DescribeReplay
<a name="API_DescribeReplay"></a>

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

## Request Syntax
<a name="API_DescribeReplay_RequestSyntax"></a>

```
{
   "ReplayName": "string"
}
```

## Request Parameters
<a name="API_DescribeReplay_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ReplayName](#API_DescribeReplay_RequestSyntax) **   <a name="eventbridge-DescribeReplay-request-ReplayName"></a>
The name of the replay to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeReplay_ResponseSyntax"></a>

```
{
   "Description": "string",
   "Destination": { 
      "Arn": "string",
      "FilterArns": [ "string" ]
   },
   "EventEndTime": number,
   "EventLastReplayedTime": number,
   "EventSourceArn": "string",
   "EventStartTime": number,
   "ReplayArn": "string",
   "ReplayEndTime": number,
   "ReplayName": "string",
   "ReplayStartTime": number,
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_DescribeReplay_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Description](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-Description"></a>
The description of the replay.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

 ** [Destination](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-Destination"></a>
A `ReplayDestination` object that contains details about the replay.  
Type: [ReplayDestination](API_ReplayDestination.md) object

 ** [EventEndTime](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-EventEndTime"></a>
The time stamp for the last event that was replayed from the archive.  
Type: Timestamp

 ** [EventLastReplayedTime](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-EventLastReplayedTime"></a>
The time that the event was last replayed.  
Type: Timestamp

 ** [EventSourceArn](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-EventSourceArn"></a>
The ARN of the archive events were replayed from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$` 

 ** [EventStartTime](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-EventStartTime"></a>
The time stamp of the first event that was last replayed from the archive.  
Type: Timestamp

 ** [ReplayArn](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-ReplayArn"></a>
The ARN of the replay.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$` 

 ** [ReplayEndTime](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-ReplayEndTime"></a>
A time stamp for the time that the replay stopped.  
Type: Timestamp

 ** [ReplayName](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-ReplayName"></a>
The name of the replay.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [ReplayStartTime](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-ReplayStartTime"></a>
A time stamp for the time that the replay started.  
Type: Timestamp

 ** [State](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-State"></a>
The current state of the replay.  
Type: String  
Valid Values: `STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED` 

 ** [StateReason](#API_DescribeReplay_ResponseSyntax) **   <a name="eventbridge-DescribeReplay-response-StateReason"></a>
The reason that the replay is in the current state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_DescribeReplay_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeReplay_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeReplay) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeReplay) 

# DescribeRule
<a name="API_DescribeRule"></a>

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use [ListTargetsByRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html).

## Request Syntax
<a name="API_DescribeRule_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DescribeRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_DescribeRule_RequestSyntax) **   <a name="eventbridge-DescribeRule-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Name](#API_DescribeRule_RequestSyntax) **   <a name="eventbridge-DescribeRule-request-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeRule_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "CreatedBy": "string",
   "Description": "string",
   "EventBusName": "string",
   "EventPattern": "string",
   "ManagedBy": "string",
   "Name": "string",
   "RoleArn": "string",
   "ScheduleExpression": "string",
   "State": "string"
}
```

## Response Elements
<a name="API_DescribeRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-Arn"></a>
The Amazon Resource Name (ARN) of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

 ** [CreatedBy](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-CreatedBy"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Description](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-Description"></a>
The description of the rule.  
Type: String  
Length Constraints: Maximum length of 512.

 ** [EventBusName](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-EventBusName"></a>
The name of the event bus associated with the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+` 

 ** [EventPattern](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-EventPattern"></a>
The event pattern. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the * *Amazon EventBridge User Guide* *.  
Type: String  
Length Constraints: Maximum length of 4096.

 ** [ManagedBy](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-ManagedBy"></a>
If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.

 ** [Name](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [RoleArn](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-RoleArn"></a>
The Amazon Resource Name (ARN) of the IAM role associated with the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

 ** [ScheduleExpression](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-ScheduleExpression"></a>
The scheduling expression. For example, "cron(0 20 \$1 \$1 ? \$1)", "rate(5 minutes)".  
Type: String  
Length Constraints: Maximum length of 256.

 ** [State](#API_DescribeRule_ResponseSyntax) **   <a name="eventbridge-DescribeRule-response-State"></a>
Specifies whether the rule is enabled or disabled.  
Type: String  
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` 

## Errors
<a name="API_DescribeRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_DescribeRule_Examples"></a>

### Describes a rule named "test"
<a name="API_DescribeRule_Example_1"></a>

The following is an example of a DescribeRule request and response.

#### Sample Request
<a name="API_DescribeRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.DescribeRule

{
    "Name": "test"
}
```

#### Sample Response
<a name="API_DescribeRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "Name": "test", 
    "EventPattern": "{\"source\":[\"aws.autoscaling\"],\"detail-type\":[\"EC2 Instance Launch Successful\",\"EC2 Instance Terminate Successful\",\"EC2 Instance Launch Unsuccessful\",\"EC2 Instance Terminate Unsuccessful\"]}", 
    "State": "ENABLED", 
    "Arn": "arn:aws:events:us-east-1:123456789012:rule/test", 
    "Description": "Test rule for Auto Scaling events"
}
```

## See Also
<a name="API_DescribeRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DescribeRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DescribeRule) 

# DisableRule
<a name="API_DisableRule"></a>

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

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

## Request Syntax
<a name="API_DisableRule_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_DisableRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_DisableRule_RequestSyntax) **   <a name="eventbridge-DisableRule-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Name](#API_DisableRule_RequestSyntax) **   <a name="eventbridge-DisableRule-request-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_DisableRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_DisableRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_DisableRule_Examples"></a>

### Disables a rule named "test"
<a name="API_DisableRule_Example_1"></a>

The following is an example of a DisableRule request.

#### Sample Request
<a name="API_DisableRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.DisableRule

{
    "Name": "test"
}
```

#### Sample Response
<a name="API_DisableRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
```

## See Also
<a name="API_DisableRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/DisableRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/DisableRule) 

# EnableRule
<a name="API_EnableRule"></a>

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

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

## Request Syntax
<a name="API_EnableRule_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_EnableRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_EnableRule_RequestSyntax) **   <a name="eventbridge-EnableRule-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Name](#API_EnableRule_RequestSyntax) **   <a name="eventbridge-EnableRule-request-Name"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Elements
<a name="API_EnableRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_EnableRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_EnableRule_Examples"></a>

### Enables a rule named "test"
<a name="API_EnableRule_Example_1"></a>

The following is an example of an EnableRule request.

#### Sample Request
<a name="API_EnableRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.EnableRule

{
    "Name": "test"
}
```

#### Sample Response
<a name="API_EnableRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
```

## See Also
<a name="API_EnableRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/EnableRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/EnableRule) 

# ListApiDestinations
<a name="API_ListApiDestinations"></a>

Retrieves a list of API destination in the account in the current Region.

## Request Syntax
<a name="API_ListApiDestinations_RequestSyntax"></a>

```
{
   "ConnectionArn": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListApiDestinations_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ConnectionArn](#API_ListApiDestinations_RequestSyntax) **   <a name="eventbridge-ListApiDestinations-request-ConnectionArn"></a>
The ARN of the connection specified for the API destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$`   
Required: No

 ** [Limit](#API_ListApiDestinations_RequestSyntax) **   <a name="eventbridge-ListApiDestinations-request-Limit"></a>
The maximum number of API destinations to include in the response.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListApiDestinations_RequestSyntax) **   <a name="eventbridge-ListApiDestinations-request-NamePrefix"></a>
A name prefix to filter results returned. Only API destinations with a name that starts with the prefix are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListApiDestinations_RequestSyntax) **   <a name="eventbridge-ListApiDestinations-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListApiDestinations_ResponseSyntax"></a>

```
{
   "ApiDestinations": [ 
      { 
         "ApiDestinationArn": "string",
         "ApiDestinationState": "string",
         "ConnectionArn": "string",
         "CreationTime": number,
         "HttpMethod": "string",
         "InvocationEndpoint": "string",
         "InvocationRateLimitPerSecond": number,
         "LastModifiedTime": number,
         "Name": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListApiDestinations_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApiDestinations](#API_ListApiDestinations_ResponseSyntax) **   <a name="eventbridge-ListApiDestinations-response-ApiDestinations"></a>
An array that includes information about each API destination.  
Type: Array of [ApiDestination](API_ApiDestination.md) objects

 ** [NextToken](#API_ListApiDestinations_ResponseSyntax) **   <a name="eventbridge-ListApiDestinations-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListApiDestinations_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_ListApiDestinations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListApiDestinations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListApiDestinations) 

# ListArchives
<a name="API_ListArchives"></a>

Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

## Request Syntax
<a name="API_ListArchives_RequestSyntax"></a>

```
{
   "EventSourceArn": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string",
   "State": "string"
}
```

## Request Parameters
<a name="API_ListArchives_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventSourceArn](#API_ListArchives_RequestSyntax) **   <a name="eventbridge-ListArchives-request-EventSourceArn"></a>
The ARN of the event source associated with the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$`   
Required: No

 ** [Limit](#API_ListArchives_RequestSyntax) **   <a name="eventbridge-ListArchives-request-Limit"></a>
The maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListArchives_RequestSyntax) **   <a name="eventbridge-ListArchives-request-NamePrefix"></a>
A name prefix to filter the archives returned. Only archives with name that match the prefix are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListArchives_RequestSyntax) **   <a name="eventbridge-ListArchives-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [State](#API_ListArchives_RequestSyntax) **   <a name="eventbridge-ListArchives-request-State"></a>
The state of the archive.  
Type: String  
Valid Values: `ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED`   
Required: No

## Response Syntax
<a name="API_ListArchives_ResponseSyntax"></a>

```
{
   "Archives": [ 
      { 
         "ArchiveName": "string",
         "CreationTime": number,
         "EventCount": number,
         "EventSourceArn": "string",
         "RetentionDays": number,
         "SizeBytes": number,
         "State": "string",
         "StateReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListArchives_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Archives](#API_ListArchives_ResponseSyntax) **   <a name="eventbridge-ListArchives-response-Archives"></a>
An array of `Archive` objects that include details about an archive.  
Type: Array of [Archive](API_Archive.md) objects

 ** [NextToken](#API_ListArchives_ResponseSyntax) **   <a name="eventbridge-ListArchives-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListArchives_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_ListArchives_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListArchives) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListArchives) 

# ListConnections
<a name="API_ListConnections"></a>

Retrieves a list of connections from the account.

## Request Syntax
<a name="API_ListConnections_RequestSyntax"></a>

```
{
   "ConnectionState": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListConnections_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ConnectionState](#API_ListConnections_RequestSyntax) **   <a name="eventbridge-ListConnections-request-ConnectionState"></a>
The state of the connection.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY`   
Required: No

 ** [Limit](#API_ListConnections_RequestSyntax) **   <a name="eventbridge-ListConnections-request-Limit"></a>
The maximum number of connections to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListConnections_RequestSyntax) **   <a name="eventbridge-ListConnections-request-NamePrefix"></a>
A name prefix to filter results returned. Only connections with a name that starts with the prefix are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListConnections_RequestSyntax) **   <a name="eventbridge-ListConnections-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListConnections_ResponseSyntax"></a>

```
{
   "Connections": [ 
      { 
         "AuthorizationType": "string",
         "ConnectionArn": "string",
         "ConnectionState": "string",
         "CreationTime": number,
         "LastAuthorizedTime": number,
         "LastModifiedTime": number,
         "Name": "string",
         "StateReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListConnections_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Connections](#API_ListConnections_ResponseSyntax) **   <a name="eventbridge-ListConnections-response-Connections"></a>
An array of connections objects that include details about the connections.  
Type: Array of [Connection](API_Connection.md) objects

 ** [NextToken](#API_ListConnections_ResponseSyntax) **   <a name="eventbridge-ListConnections-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListConnections_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_ListConnections_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListConnections) 

# ListEndpoints
<a name="API_ListEndpoints"></a>

List the global endpoints associated with this account. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the * *Amazon EventBridge User Guide* *.

## Request Syntax
<a name="API_ListEndpoints_RequestSyntax"></a>

```
{
   "HomeRegion": "string",
   "MaxResults": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListEndpoints_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [HomeRegion](#API_ListEndpoints_RequestSyntax) **   <a name="eventbridge-ListEndpoints-request-HomeRegion"></a>
The primary Region of the endpoints associated with this account. For example `"HomeRegion": "us-east-1"`.  
Type: String  
Length Constraints: Minimum length of 9. Maximum length of 20.  
Pattern: `^[\-a-z0-9]+$`   
Required: No

 ** [MaxResults](#API_ListEndpoints_RequestSyntax) **   <a name="eventbridge-ListEndpoints-request-MaxResults"></a>
The maximum number of results returned by the call.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListEndpoints_RequestSyntax) **   <a name="eventbridge-ListEndpoints-request-NamePrefix"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListEndpoints_RequestSyntax) **   <a name="eventbridge-ListEndpoints-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListEndpoints_ResponseSyntax"></a>

```
{
   "Endpoints": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "Description": "string",
         "EndpointId": "string",
         "EndpointUrl": "string",
         "EventBuses": [ 
            { 
               "EventBusArn": "string"
            }
         ],
         "LastModifiedTime": number,
         "Name": "string",
         "ReplicationConfig": { 
            "State": "string"
         },
         "RoleArn": "string",
         "RoutingConfig": { 
            "FailoverConfig": { 
               "Primary": { 
                  "HealthCheck": "string"
               },
               "Secondary": { 
                  "Route": "string"
               }
            }
         },
         "State": "string",
         "StateReason": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEndpoints_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Endpoints](#API_ListEndpoints_ResponseSyntax) **   <a name="eventbridge-ListEndpoints-response-Endpoints"></a>
The endpoints returned by the call.  
Type: Array of [Endpoint](API_Endpoint.md) objects

 ** [NextToken](#API_ListEndpoints_ResponseSyntax) **   <a name="eventbridge-ListEndpoints-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListEndpoints_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_ListEndpoints_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListEndpoints) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListEndpoints) 

# ListEventBuses
<a name="API_ListEventBuses"></a>

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

## Request Syntax
<a name="API_ListEventBuses_RequestSyntax"></a>

```
{
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListEventBuses_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListEventBuses_RequestSyntax) **   <a name="eventbridge-ListEventBuses-request-Limit"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListEventBuses_RequestSyntax) **   <a name="eventbridge-ListEventBuses-request-NamePrefix"></a>
Specifying this limits the results to only those event buses with names that start with the specified prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListEventBuses_RequestSyntax) **   <a name="eventbridge-ListEventBuses-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListEventBuses_ResponseSyntax"></a>

```
{
   "EventBuses": [ 
      { 
         "Arn": "string",
         "CreationTime": number,
         "Description": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Policy": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEventBuses_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventBuses](#API_ListEventBuses_ResponseSyntax) **   <a name="eventbridge-ListEventBuses-response-EventBuses"></a>
This list of event buses.  
Type: Array of [EventBus](API_EventBus.md) objects

 ** [NextToken](#API_ListEventBuses_ResponseSyntax) **   <a name="eventbridge-ListEventBuses-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListEventBuses_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_ListEventBuses_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListEventBuses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListEventBuses) 

# ListEventSources
<a name="API_ListEventSources"></a>

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

## Request Syntax
<a name="API_ListEventSources_RequestSyntax"></a>

```
{
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListEventSources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListEventSources_RequestSyntax) **   <a name="eventbridge-ListEventSources-request-Limit"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListEventSources_RequestSyntax) **   <a name="eventbridge-ListEventSources-request-NamePrefix"></a>
Specifying this limits the results to only those partner event sources with names that start with the specified prefix.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListEventSources_RequestSyntax) **   <a name="eventbridge-ListEventSources-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListEventSources_ResponseSyntax"></a>

```
{
   "EventSources": [ 
      { 
         "Arn": "string",
         "CreatedBy": "string",
         "CreationTime": number,
         "ExpirationTime": number,
         "Name": "string",
         "State": "string"
      }
   ],
   "NextToken": "string"
}
```

## Response Elements
<a name="API_ListEventSources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [EventSources](#API_ListEventSources_ResponseSyntax) **   <a name="eventbridge-ListEventSources-response-EventSources"></a>
The list of event sources.  
Type: Array of [EventSource](API_EventSource.md) objects

 ** [NextToken](#API_ListEventSources_ResponseSyntax) **   <a name="eventbridge-ListEventSources-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

## Errors
<a name="API_ListEventSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

## See Also
<a name="API_ListEventSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListEventSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListEventSources) 

# ListPartnerEventSourceAccounts
<a name="API_ListPartnerEventSourceAccounts"></a>

An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.

## Request Syntax
<a name="API_ListPartnerEventSourceAccounts_RequestSyntax"></a>

```
{
   "EventSourceName": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListPartnerEventSourceAccounts_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventSourceName](#API_ListPartnerEventSourceAccounts_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSourceAccounts-request-EventSourceName"></a>
The name of the partner event source to display account information about.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner(/[\.\-_A-Za-z0-9]+){2,}`   
Required: Yes

 ** [Limit](#API_ListPartnerEventSourceAccounts_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSourceAccounts-request-Limit"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListPartnerEventSourceAccounts_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSourceAccounts-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListPartnerEventSourceAccounts_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "PartnerEventSourceAccounts": [ 
      { 
         "Account": "string",
         "CreationTime": number,
         "ExpirationTime": number,
         "State": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPartnerEventSourceAccounts_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPartnerEventSourceAccounts_ResponseSyntax) **   <a name="eventbridge-ListPartnerEventSourceAccounts-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [PartnerEventSourceAccounts](#API_ListPartnerEventSourceAccounts_ResponseSyntax) **   <a name="eventbridge-ListPartnerEventSourceAccounts-response-PartnerEventSourceAccounts"></a>
The list of partner event sources returned by the operation.  
Type: Array of [PartnerEventSourceAccount](API_PartnerEventSourceAccount.md) objects

## Errors
<a name="API_ListPartnerEventSourceAccounts_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_ListPartnerEventSourceAccounts_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListPartnerEventSourceAccounts) 

# ListPartnerEventSources
<a name="API_ListPartnerEventSources"></a>

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.

## Request Syntax
<a name="API_ListPartnerEventSources_RequestSyntax"></a>

```
{
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListPartnerEventSources_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Limit](#API_ListPartnerEventSources_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSources-request-Limit"></a>
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.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListPartnerEventSources_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSources-request-NamePrefix"></a>
If you specify this, the results are limited to only those partner event sources that start with the string you specify.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `aws\.partner/[\.\-_A-Za-z0-9]+/[/\.\-_A-Za-z0-9]*`   
Required: Yes

 ** [NextToken](#API_ListPartnerEventSources_RequestSyntax) **   <a name="eventbridge-ListPartnerEventSources-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListPartnerEventSources_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "PartnerEventSources": [ 
      { 
         "Arn": "string",
         "Name": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListPartnerEventSources_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListPartnerEventSources_ResponseSyntax) **   <a name="eventbridge-ListPartnerEventSources-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [PartnerEventSources](#API_ListPartnerEventSources_ResponseSyntax) **   <a name="eventbridge-ListPartnerEventSources-response-PartnerEventSources"></a>
The list of partner event sources returned by the operation.  
Type: Array of [PartnerEventSource](API_PartnerEventSource.md) objects

## Errors
<a name="API_ListPartnerEventSources_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

## See Also
<a name="API_ListPartnerEventSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListPartnerEventSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListPartnerEventSources) 

# ListReplays
<a name="API_ListReplays"></a>

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

## Request Syntax
<a name="API_ListReplays_RequestSyntax"></a>

```
{
   "EventSourceArn": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string",
   "State": "string"
}
```

## Request Parameters
<a name="API_ListReplays_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventSourceArn](#API_ListReplays_RequestSyntax) **   <a name="eventbridge-ListReplays-request-EventSourceArn"></a>
The ARN of the archive from which the events are replayed.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$`   
Required: No

 ** [Limit](#API_ListReplays_RequestSyntax) **   <a name="eventbridge-ListReplays-request-Limit"></a>
The maximum number of replays to retrieve.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListReplays_RequestSyntax) **   <a name="eventbridge-ListReplays-request-NamePrefix"></a>
A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListReplays_RequestSyntax) **   <a name="eventbridge-ListReplays-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [State](#API_ListReplays_RequestSyntax) **   <a name="eventbridge-ListReplays-request-State"></a>
The state of the replay.  
Type: String  
Valid Values: `STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED`   
Required: No

## Response Syntax
<a name="API_ListReplays_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Replays": [ 
      { 
         "EventEndTime": number,
         "EventLastReplayedTime": number,
         "EventSourceArn": "string",
         "EventStartTime": number,
         "ReplayEndTime": number,
         "ReplayName": "string",
         "ReplayStartTime": number,
         "State": "string",
         "StateReason": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListReplays_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListReplays_ResponseSyntax) **   <a name="eventbridge-ListReplays-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Replays](#API_ListReplays_ResponseSyntax) **   <a name="eventbridge-ListReplays-response-Replays"></a>
An array of `Replay` objects that contain information about the replay.  
Type: Array of [Replay](API_Replay.md) objects

## Errors
<a name="API_ListReplays_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## See Also
<a name="API_ListReplays_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListReplays) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListReplays) 

# ListRuleNamesByTarget
<a name="API_ListRuleNamesByTarget"></a>

Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.

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

## Request Syntax
<a name="API_ListRuleNamesByTarget_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Limit": number,
   "NextToken": "string",
   "TargetArn": "string"
}
```

## Request Parameters
<a name="API_ListRuleNamesByTarget_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_ListRuleNamesByTarget_RequestSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-request-EventBusName"></a>
The name or ARN of the event bus to list rules for. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Limit](#API_ListRuleNamesByTarget_RequestSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-request-Limit"></a>
The maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListRuleNamesByTarget_RequestSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [TargetArn](#API_ListRuleNamesByTarget_RequestSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-request-TargetArn"></a>
The Amazon Resource Name (ARN) of the target resource.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

## Response Syntax
<a name="API_ListRuleNamesByTarget_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "RuleNames": [ "string" ]
}
```

## Response Elements
<a name="API_ListRuleNamesByTarget_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRuleNamesByTarget_ResponseSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [RuleNames](#API_ListRuleNamesByTarget_ResponseSyntax) **   <a name="eventbridge-ListRuleNamesByTarget-response-RuleNames"></a>
The names of the rules that can invoke the given target.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

## Errors
<a name="API_ListRuleNamesByTarget_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_ListRuleNamesByTarget_Examples"></a>

### Lists rule names by target with the specified ARN
<a name="API_ListRuleNamesByTarget_Example_1"></a>

The following is an example of a ListRuleNamesByTarget request and response.

#### Sample Request
<a name="API_ListRuleNamesByTarget_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.ListRuleNamesByTarget

{
    "TargetArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
    "NextToken": "", 
    "Limit": 0
}
```

#### Sample Response
<a name="API_ListRuleNamesByTarget_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "RuleNames": [
        "test1", 
        "test2", 
        "test3", 
        "test4", 
        "test5"
    ]
}
```

## See Also
<a name="API_ListRuleNamesByTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListRuleNamesByTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListRuleNamesByTarget) 

# ListRules
<a name="API_ListRules"></a>

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

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

ListRules does not list the targets of a rule. To see the targets associated with a rule, use [ListTargetsByRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_ListTargetsByRule.html).

## Request Syntax
<a name="API_ListRules_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Limit": number,
   "NamePrefix": "string",
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_ListRules_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_ListRules_RequestSyntax) **   <a name="eventbridge-ListRules-request-EventBusName"></a>
The name or ARN of the event bus to list the rules for. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Limit](#API_ListRules_RequestSyntax) **   <a name="eventbridge-ListRules-request-Limit"></a>
The maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NamePrefix](#API_ListRules_RequestSyntax) **   <a name="eventbridge-ListRules-request-NamePrefix"></a>
The prefix matching the rule name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [NextToken](#API_ListRules_RequestSyntax) **   <a name="eventbridge-ListRules-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

## Response Syntax
<a name="API_ListRules_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Rules": [ 
      { 
         "Arn": "string",
         "Description": "string",
         "EventBusName": "string",
         "EventPattern": "string",
         "ManagedBy": "string",
         "Name": "string",
         "RoleArn": "string",
         "ScheduleExpression": "string",
         "State": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListRules_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListRules_ResponseSyntax) **   <a name="eventbridge-ListRules-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Rules](#API_ListRules_ResponseSyntax) **   <a name="eventbridge-ListRules-response-Rules"></a>
The rules that match the specified criteria.  
Type: Array of [Rule](API_Rule.md) objects

## Errors
<a name="API_ListRules_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_ListRules_Examples"></a>

### Lists all the rules that start with the letter "t" with a page size of 1
<a name="API_ListRules_Example_1"></a>

The following is an example of a ListRules request and response.

#### Sample Request
<a name="API_ListRules_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.ListRules

{
    "NamePrefix": "t", 
    "Limit": 1
}
```

#### Sample Response
<a name="API_ListRules_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "Rules": [
        {
            "EventPattern": "{\"source\":[\"aws.autoscaling\"],\"detail-type\":[\"EC2 Instance Launch Successful\",\"EC2 Instance Terminate Successful\",\"EC2 Instance Launch Unsuccessful\",\"EC2 Instance Terminate Unsuccessful\"]}", 
            "State": "DISABLED", 
            "Name": "test", 
            "Arn": "arn:aws:events:us-east-1:123456789012:rule/test", 
            "Description": "Test rule for Auto Scaling events"
        }
    ], 
    "NextToken": "ABCDEgAAAAAAAAAAQAAABCXtD8i7XlyFv5XFKH8GrudAAAAQIoQ0+7qXp63vQf1pvVklfHFd+p2QgY36pjlAqsSsrkNbOtTePaCeJqN8O+jbu66UhpJh7huA9r0iY9zjdtZ3vsAAAAgAAAAAAAAAAF5MZWktllmMuLd9gUjryM4sL9EG5IkcPUm60Vq1tzyYw=="
}
```

## See Also
<a name="API_ListRules_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListRules) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListRules) 

# ListTagsForResource
<a name="API_ListTagsForResource"></a>

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

## Request Syntax
<a name="API_ListTagsForResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string"
}
```

## Request Parameters
<a name="API_ListTagsForResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_ListTagsForResource_RequestSyntax) **   <a name="eventbridge-ListTagsForResource-request-ResourceARN"></a>
The ARN of the EventBridge resource for which you want to view tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

## Response Syntax
<a name="API_ListTagsForResource_ResponseSyntax"></a>

```
{
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Response Elements
<a name="API_ListTagsForResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Tags](#API_ListTagsForResource_ResponseSyntax) **   <a name="eventbridge-ListTagsForResource-response-Tags"></a>
The list of tag keys and values associated with the resource you specified  
Type: Array of [Tag](API_Tag.md) objects

## Errors
<a name="API_ListTagsForResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_ListTagsForResource_Examples"></a>

### Removes two tags from an EventBridge rule
<a name="API_ListTagsForResource_Example_1"></a>

The following is an example of an `UntagResource` request.

#### Sample Request
<a name="API_ListTagsForResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.ListTagsForResource

{
    "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",
}
```

#### Sample Response
<a name="API_ListTagsForResource_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "Tags": [
        {
            "Key": "Stack",
            "Value": "Prod"
        },
        {
            "Key": "CostCenter",
            "Value": "12345"
        }
    ]
}
```

## See Also
<a name="API_ListTagsForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListTagsForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListTagsForResource) 

# ListTargetsByRule
<a name="API_ListTargetsByRule"></a>

Lists the targets assigned to the specified rule.

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

## Request Syntax
<a name="API_ListTargetsByRule_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Limit": number,
   "NextToken": "string",
   "Rule": "string"
}
```

## Request Parameters
<a name="API_ListTargetsByRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_ListTargetsByRule_RequestSyntax) **   <a name="eventbridge-ListTargetsByRule-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Limit](#API_ListTargetsByRule_RequestSyntax) **   <a name="eventbridge-ListTargetsByRule-request-Limit"></a>
The maximum number of results to return.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 100.  
Required: No

 ** [NextToken](#API_ListTargetsByRule_RequestSyntax) **   <a name="eventbridge-ListTargetsByRule-request-NextToken"></a>
The token returned by a previous call, which you can use to retrieve the next set of results.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Required: No

 ** [Rule](#API_ListTargetsByRule_RequestSyntax) **   <a name="eventbridge-ListTargetsByRule-request-Rule"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_ListTargetsByRule_ResponseSyntax"></a>

```
{
   "NextToken": "string",
   "Targets": [ 
      { 
         "AppSyncParameters": { 
            "GraphQLOperation": "string"
         },
         "Arn": "string",
         "BatchParameters": { 
            "ArrayProperties": { 
               "Size": number
            },
            "JobDefinition": "string",
            "JobName": "string",
            "RetryStrategy": { 
               "Attempts": number
            }
         },
         "DeadLetterConfig": { 
            "Arn": "string"
         },
         "EcsParameters": { 
            "CapacityProviderStrategy": [ 
               { 
                  "base": number,
                  "capacityProvider": "string",
                  "weight": number
               }
            ],
            "EnableECSManagedTags": boolean,
            "EnableExecuteCommand": boolean,
            "Group": "string",
            "LaunchType": "string",
            "NetworkConfiguration": { 
               "awsvpcConfiguration": { 
                  "AssignPublicIp": "string",
                  "SecurityGroups": [ "string" ],
                  "Subnets": [ "string" ]
               }
            },
            "PlacementConstraints": [ 
               { 
                  "expression": "string",
                  "type": "string"
               }
            ],
            "PlacementStrategy": [ 
               { 
                  "field": "string",
                  "type": "string"
               }
            ],
            "PlatformVersion": "string",
            "PropagateTags": "string",
            "ReferenceId": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "TaskCount": number,
            "TaskDefinitionArn": "string"
         },
         "HttpParameters": { 
            "HeaderParameters": { 
               "string" : "string" 
            },
            "PathParameterValues": [ "string" ],
            "QueryStringParameters": { 
               "string" : "string" 
            }
         },
         "Id": "string",
         "Input": "string",
         "InputPath": "string",
         "InputTransformer": { 
            "InputPathsMap": { 
               "string" : "string" 
            },
            "InputTemplate": "string"
         },
         "KinesisParameters": { 
            "PartitionKeyPath": "string"
         },
         "RedshiftDataParameters": { 
            "Database": "string",
            "DbUser": "string",
            "SecretManagerArn": "string",
            "Sql": "string",
            "Sqls": [ "string" ],
            "StatementName": "string",
            "WithEvent": boolean
         },
         "RetryPolicy": { 
            "MaximumEventAgeInSeconds": number,
            "MaximumRetryAttempts": number
         },
         "RoleArn": "string",
         "RunCommandParameters": { 
            "RunCommandTargets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ]
         },
         "SageMakerPipelineParameters": { 
            "PipelineParameterList": [ 
               { 
                  "Name": "string",
                  "Value": "string"
               }
            ]
         },
         "SqsParameters": { 
            "MessageGroupId": "string"
         }
      }
   ]
}
```

## Response Elements
<a name="API_ListTargetsByRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [NextToken](#API_ListTargetsByRule_ResponseSyntax) **   <a name="eventbridge-ListTargetsByRule-response-NextToken"></a>
A token indicating there are more results available. If there are no more results, no token is included in the response.  
The value of `nextToken` is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.  
 Using an expired pagination token results in an `HTTP 400 InvalidToken` error.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.

 ** [Targets](#API_ListTargetsByRule_ResponseSyntax) **   <a name="eventbridge-ListTargetsByRule-response-Targets"></a>
The targets assigned to the rule.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.

## Errors
<a name="API_ListTargetsByRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_ListTargetsByRule_Examples"></a>

### Lists the targets associated with a rule named "test"
<a name="API_ListTargetsByRule_Example_1"></a>

The following is an example of a ListTargetsByRule request and response.

#### Sample Request
<a name="API_ListTargetsByRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.ListTargetsByRule

{
    "Rule": "test" 
}
```

#### Sample Response
<a name="API_ListTargetsByRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "Targets": [
        {
            "Id": "MyTargetId", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction"
        }
    ]
}
```

## See Also
<a name="API_ListTargetsByRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/ListTargetsByRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/ListTargetsByRule) 

# PutEvents
<a name="API_PutEvents"></a>

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

You can batch multiple event entries into one request for efficiency. However, the total entry size must be less than 1MB. You can calculate the entry size before you send the events. For more information, see [Calculating PutEvents event entry size](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevents.html#eb-putevent-size) in the * *Amazon EventBridge User Guide* *.

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

**Note**  
PutEvents will only process nested JSON up to 1000 levels deep.

## Request Syntax
<a name="API_PutEvents_RequestSyntax"></a>

```
{
   "EndpointId": "string",
   "Entries": [ 
      { 
         "Detail": "string",
         "DetailType": "string",
         "EventBusName": "string",
         "Resources": [ "string" ],
         "Source": "string",
         "Time": number,
         "TraceHeader": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_PutEvents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EndpointId](#API_PutEvents_RequestSyntax) **   <a name="eventbridge-PutEvents-request-EndpointId"></a>
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.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$`   
Required: No

 ** [Entries](#API_PutEvents_RequestSyntax) **   <a name="eventbridge-PutEvents-request-Entries"></a>
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.  
Type: Array of [PutEventsRequestEntry](API_PutEventsRequestEntry.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: Yes

## Response Syntax
<a name="API_PutEvents_ResponseSyntax"></a>

```
{
   "Entries": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "EventId": "string"
      }
   ],
   "FailedEntryCount": number
}
```

## Response Elements
<a name="API_PutEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Entries](#API_PutEvents_ResponseSyntax) **   <a name="eventbridge-PutEvents-response-Entries"></a>
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.  
Type: Array of [PutEventsResultEntry](API_PutEventsResultEntry.md) objects

 ** [FailedEntryCount](#API_PutEvents_ResponseSyntax) **   <a name="eventbridge-PutEvents-response-FailedEntryCount"></a>
The number of failed entries.  
Type: Integer

## Errors
<a name="API_PutEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

## Examples
<a name="API_PutEvents_Examples"></a>

### Sends two custom events
<a name="API_PutEvents_Example_1"></a>

The following is an example of a PutEvents request and response.

#### Sample Request
<a name="API_PutEvents_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutEvents

{
   "Entries":[
      {
         "Source":"com.mycompany.myapp",
         "Detail":"{ \"key1\": \"value1\", \"key2\": \"value2\" }",
         "Resources":[
            "resource1",
            "resource2"
         ],
         "DetailType":"myDetailType"
      },
      {
         "Source":"com.mycompany.myapp",
         "Detail":"{ \"key1\": \"value3\", \"key2\": \"value4\" }",
         "Resources":[
            "resource1",
            "resource2"
         ],
         "DetailType":"myDetailType"
      }
   ]
}
```

#### Sample Response
<a name="API_PutEvents_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "FailedEntryCount": 0, 
    "Entries": [
        {
            "EventId": "11710aed-b79e-4468-a20b-bb3c0c3b4860"
        }, 
        {
            "EventId": "d804d26a-88db-4b66-9eaf-9a11c708ae82"
        }
    ]
}
```

## See Also
<a name="API_PutEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/PutEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/PutEvents) 

# PutPartnerEvents
<a name="API_PutPartnerEvents"></a>

This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.

For information on calculating event batch size, see [Calculating EventBridge PutEvents event entry size](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html) in the *EventBridge User Guide*.

## Request Syntax
<a name="API_PutPartnerEvents_RequestSyntax"></a>

```
{
   "Entries": [ 
      { 
         "Detail": "string",
         "DetailType": "string",
         "Resources": [ "string" ],
         "Source": "string",
         "Time": number
      }
   ]
}
```

## Request Parameters
<a name="API_PutPartnerEvents_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Entries](#API_PutPartnerEvents_RequestSyntax) **   <a name="eventbridge-PutPartnerEvents-request-Entries"></a>
The list of events to write to the event bus.  
Type: Array of [PutPartnerEventsRequestEntry](API_PutPartnerEventsRequestEntry.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 20 items.  
Required: Yes

## Response Syntax
<a name="API_PutPartnerEvents_ResponseSyntax"></a>

```
{
   "Entries": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "EventId": "string"
      }
   ],
   "FailedEntryCount": number
}
```

## Response Elements
<a name="API_PutPartnerEvents_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Entries](#API_PutPartnerEvents_ResponseSyntax) **   <a name="eventbridge-PutPartnerEvents-response-Entries"></a>
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.  
Type: Array of [PutPartnerEventsResultEntry](API_PutPartnerEventsResultEntry.md) objects

 ** [FailedEntryCount](#API_PutPartnerEvents_ResponseSyntax) **   <a name="eventbridge-PutPartnerEvents-response-FailedEntryCount"></a>
The number of events from this operation that could not be written to the partner event bus.  
Type: Integer

## Errors
<a name="API_PutPartnerEvents_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

## See Also
<a name="API_PutPartnerEvents_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/PutPartnerEvents) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/PutPartnerEvents) 

# PutPermission
<a name="API_PutPermission"></a>

Running `PutPermission` permits the specified AWS account or AWS organization to put events to the specified *event bus*. Amazon EventBridge rules in your account are triggered by these events arriving to an event bus in your account. 

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

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

If you grant permissions using an organization, then accounts in that organization must specify a `RoleArn` with proper permissions when they use `PutTarget` to add your account's event bus as a target. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*.

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

## Request Syntax
<a name="API_PutPermission_RequestSyntax"></a>

```
{
   "Action": "string",
   "Condition": { 
      "Key": "string",
      "Type": "string",
      "Value": "string"
   },
   "EventBusName": "string",
   "Policy": "string",
   "Principal": "string",
   "StatementId": "string"
}
```

## Request Parameters
<a name="API_PutPermission_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Action](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-Action"></a>
The action that you are enabling the other account to perform.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `events:[a-zA-Z]+`   
Required: No

 ** [Condition](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-Condition"></a>
This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see [What Is AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) in the * AWS Organizations User Guide*.  
If you specify `Condition` with an AWS organization ID, and specify "\$1" 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.  
Type: [Condition](API_Condition.md) object  
Required: No

 ** [EventBusName](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-EventBusName"></a>
The name of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [Policy](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-Policy"></a>
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.  
Type: String  
Required: No

 ** [Principal](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-Principal"></a>
The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "\$1" to permit any account to put events to your default event bus.  
If you specify "\$1" 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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 12.  
Pattern: `(\d{12}|\*)`   
Required: No

 ** [StatementId](#API_PutPermission_RequestSyntax) **   <a name="eventbridge-PutPermission-request-StatementId"></a>
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](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html).  
Each `StatementId` must be unique.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

## Response Elements
<a name="API_PutPermission_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_PutPermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** PolicyLengthExceededException **   
The event bus policy is too long. For more information, see the limits.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_PutPermission_Examples"></a>

The following example enables the current account to receive events from account `111122223333`.

### Example
<a name="API_PutPermission_Example_1"></a>

This example illustrates one usage of PutPermission.

#### Sample Request
<a name="API_PutPermission_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutPermission

{
   "Action":"events:PutEvents"
   "Principal":"111122223333"
   "StatementId":"MyStatement"
 
}
```

### Example
<a name="API_PutPermission_Example_2"></a>

The following example grants permissions to all accounts in the organization with an ID of `o-1234567890` 

#### Sample Request
<a name="API_PutPermission_Example_2_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutPermission

{
   "Action":"events:PutEvents"
   "Principal":"*"
   "Condition": '{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'
   "StatementId":"MyStatement"
 
}
```

## See Also
<a name="API_PutPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/PutPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/PutPermission) 

# PutRule
<a name="API_PutRule"></a>

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using [DisableRule](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DisableRule.html).

A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see [CreateEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateEventBus.html).

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

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

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

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the `PutRule` operation and assign tags, you must have both the `events:PutRule` and `events:TagResource` permissions.

If you are updating an existing rule, any tags you specify in the `PutRule` operation are ignored. To update the tags of an existing rule, use [TagResource](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_TagResource.html) and [UntagResource](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UntagResource.html).

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

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

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

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see [Managing Your Costs with Budgets](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-managing-costs.html).

To create a rule that filters for management events from AWS services, see [Receiving read-only management events from AWS services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event-cloudtrail.html#eb-service-event-cloudtrail-management) in the *EventBridge User Guide*.

## Request Syntax
<a name="API_PutRule_RequestSyntax"></a>

```
{
   "Description": "string",
   "EventBusName": "string",
   "EventPattern": "string",
   "Name": "string",
   "RoleArn": "string",
   "ScheduleExpression": "string",
   "State": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_PutRule_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-Description"></a>
A description of the rule.  
Type: String  
Length Constraints: Maximum length of 512.  
Required: No

 ** [EventBusName](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-EventBusName"></a>
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [EventPattern](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-EventPattern"></a>
The event pattern. For more information, see [Amazon EventBridge event patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html) in the * *Amazon EventBridge User Guide* *.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: No

 ** [Name](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-Name"></a>
The name of the rule that you are creating or updating.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [RoleArn](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-RoleArn"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: No

 ** [ScheduleExpression](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-ScheduleExpression"></a>
The scheduling expression. For example, "cron(0 20 \$1 \$1 ? \$1)" or "rate(5 minutes)".  
Type: String  
Length Constraints: Maximum length of 256.  
Required: No

 ** [State](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-State"></a>
The state of the rule.  
Valid values include:  
+  `DISABLED`: The rule is disabled. EventBridge does not match any events against the rule.
+  `ENABLED`: The rule is enabled. EventBridge matches events against the rule, *except* for AWS management events delivered through CloudTrail.
+  `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`: The rule is enabled for all events, including AWS management events delivered through CloudTrail.

  Management events provide visibility into management operations that are performed on resources in your AWS account. These are also known as control plane operations. For more information, see [Logging management events](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html#logging-management-events) in the *CloudTrail User Guide*, and [Filtering management events from AWS services](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-cloudtrail) in the * *Amazon EventBridge User Guide* *.

  This value is only valid for rules on the [default](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is-how-it-works-concepts.html#eb-bus-concepts-buses) event bus or [custom event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-event-bus.html). It does not apply to [partner event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-saas.html).
Type: String  
Valid Values: `ENABLED | DISABLED | ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`   
Required: No

 ** [Tags](#API_PutRule_RequestSyntax) **   <a name="eventbridge-PutRule-request-Tags"></a>
The list of key-value pairs to associate with the rule.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## Response Syntax
<a name="API_PutRule_ResponseSyntax"></a>

```
{
   "RuleArn": "string"
}
```

## Response Elements
<a name="API_PutRule_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [RuleArn](#API_PutRule_ResponseSyntax) **   <a name="eventbridge-PutRule-response-RuleArn"></a>
The Amazon Resource Name (ARN) of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.

## Errors
<a name="API_PutRule_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidEventPatternException **   
The event pattern is not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_PutRule_Examples"></a>

### Creates a rule named "test" that matches events from Amazon EC2. The rule is also given two tags.
<a name="API_PutRule_Example_1"></a>

The following is an example of a PutRule request and response.

#### Sample Request
<a name="API_PutRule_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutRule

{
    "Name": "test",
    "EventPattern": "{ \"source\": [\"aws.ec2\"] }",
    "Tags": [
        {
            "Key": "Stack",
            "Value": "Prod"
        },
        {
            "Key": "CostCenter",
            "Value": "12345"
        }
    ]
}
```

#### Sample Response
<a name="API_PutRule_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "RuleArn": "arn:aws:events:us-east-1:123456789012:rule/test"
}
```

## See Also
<a name="API_PutRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/PutRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/PutRule) 

# PutTargets
<a name="API_PutTargets"></a>

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

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

The maximum number of entries per request is 10.

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

For a list of services you can configure as targets for events, see [EventBridge targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-targets.html) in the * *Amazon EventBridge User Guide* *.

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are:
+  `Amazon EBS CreateSnapshot API call` 
+  `Amazon EC2 RebootInstances API call` 
+  `Amazon EC2 StopInstances API call` 
+  `Amazon EC2 TerminateInstances API call` 

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

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions: 
+ For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
+ For EC2 instances, Kinesis Data Streams, AWS Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the `RoleARN` argument in `PutTargets`.

For more information, see [Authentication and Access Control](https://docs.aws.amazon.com/eventbridge/latest/userguide/auth-and-access-control-eventbridge.html) in the * *Amazon EventBridge User Guide* *.

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

**Note**  
 `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a `RoleArn` with proper permissions in the `Target` structure. For more information, see [Sending and Receiving Events Between AWS Accounts](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-cross-account-event-delivery.html) in the *Amazon EventBridge User Guide*.

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

For more information about enabling cross-account events, see [PutPermission](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutPermission.html).

 **Input**, **InputPath**, and **InputTransformer** are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
+ If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
+ If **Input** is specified in the form of valid JSON, then the matched event is overridden with this constant.
+ If **InputPath** is specified in the form of JSONPath (for example, `$.detail`), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
+ If **InputTransformer** is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

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

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

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

## Request Syntax
<a name="API_PutTargets_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Rule": "string",
   "Targets": [ 
      { 
         "AppSyncParameters": { 
            "GraphQLOperation": "string"
         },
         "Arn": "string",
         "BatchParameters": { 
            "ArrayProperties": { 
               "Size": number
            },
            "JobDefinition": "string",
            "JobName": "string",
            "RetryStrategy": { 
               "Attempts": number
            }
         },
         "DeadLetterConfig": { 
            "Arn": "string"
         },
         "EcsParameters": { 
            "CapacityProviderStrategy": [ 
               { 
                  "base": number,
                  "capacityProvider": "string",
                  "weight": number
               }
            ],
            "EnableECSManagedTags": boolean,
            "EnableExecuteCommand": boolean,
            "Group": "string",
            "LaunchType": "string",
            "NetworkConfiguration": { 
               "awsvpcConfiguration": { 
                  "AssignPublicIp": "string",
                  "SecurityGroups": [ "string" ],
                  "Subnets": [ "string" ]
               }
            },
            "PlacementConstraints": [ 
               { 
                  "expression": "string",
                  "type": "string"
               }
            ],
            "PlacementStrategy": [ 
               { 
                  "field": "string",
                  "type": "string"
               }
            ],
            "PlatformVersion": "string",
            "PropagateTags": "string",
            "ReferenceId": "string",
            "Tags": [ 
               { 
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "TaskCount": number,
            "TaskDefinitionArn": "string"
         },
         "HttpParameters": { 
            "HeaderParameters": { 
               "string" : "string" 
            },
            "PathParameterValues": [ "string" ],
            "QueryStringParameters": { 
               "string" : "string" 
            }
         },
         "Id": "string",
         "Input": "string",
         "InputPath": "string",
         "InputTransformer": { 
            "InputPathsMap": { 
               "string" : "string" 
            },
            "InputTemplate": "string"
         },
         "KinesisParameters": { 
            "PartitionKeyPath": "string"
         },
         "RedshiftDataParameters": { 
            "Database": "string",
            "DbUser": "string",
            "SecretManagerArn": "string",
            "Sql": "string",
            "Sqls": [ "string" ],
            "StatementName": "string",
            "WithEvent": boolean
         },
         "RetryPolicy": { 
            "MaximumEventAgeInSeconds": number,
            "MaximumRetryAttempts": number
         },
         "RoleArn": "string",
         "RunCommandParameters": { 
            "RunCommandTargets": [ 
               { 
                  "Key": "string",
                  "Values": [ "string" ]
               }
            ]
         },
         "SageMakerPipelineParameters": { 
            "PipelineParameterList": [ 
               { 
                  "Name": "string",
                  "Value": "string"
               }
            ]
         },
         "SqsParameters": { 
            "MessageGroupId": "string"
         }
      }
   ]
}
```

## Request Parameters
<a name="API_PutTargets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_PutTargets_RequestSyntax) **   <a name="eventbridge-PutTargets-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Rule](#API_PutTargets_RequestSyntax) **   <a name="eventbridge-PutTargets-request-Rule"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [Targets](#API_PutTargets_RequestSyntax) **   <a name="eventbridge-PutTargets-request-Targets"></a>
The targets to update or add to the rule.  
Type: Array of [Target](API_Target.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Required: Yes

## Response Syntax
<a name="API_PutTargets_ResponseSyntax"></a>

```
{
   "FailedEntries": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "TargetId": "string"
      }
   ],
   "FailedEntryCount": number
}
```

## Response Elements
<a name="API_PutTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedEntries](#API_PutTargets_ResponseSyntax) **   <a name="eventbridge-PutTargets-response-FailedEntries"></a>
The failed target entries.  
Type: Array of [PutTargetsResultEntry](API_PutTargetsResultEntry.md) objects

 ** [FailedEntryCount](#API_PutTargets_ResponseSyntax) **   <a name="eventbridge-PutTargets-response-FailedEntryCount"></a>
The number of failed entries.  
Type: Integer

## Errors
<a name="API_PutTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_PutTargets_Examples"></a>

### Adds a target to a Lambda function with the ID "MyTargetId" to the rule named "test"
<a name="API_PutTargets_Example_1"></a>

The following is an example of a PutTargets request.

#### Sample Request
<a name="API_PutTargets_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "test", 
    "Targets": [
        {
            "Id": "MyTargetId", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" 
        }
    ]
}
```

#### Sample Response
<a name="API_PutTargets_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "FailedEntries": [],
    "FailedEntryCount": 0
}
```

### Use Input Transformer to extract data from an event and input that data to the target
<a name="API_PutTargets_Example_2"></a>

This example extracts the instance and state from an event, puts them into a simple text template, and passes this data to a Lambda function called `MyFunction`.

**Note**  
If your are using `InputTransformer` with CloudWatch Logs as a target, the `Template` must be `{"timestamp":<timestamp>,"message":<version-id>}`.

#### Sample Request
<a name="API_PutTargets_Example_2_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "testrule", 
    "Targets": [
        {
            "Id": "MyTargetId", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", 
            "InputTransformer":
              {
                "InputPathsMap": {"instance": "$.detail.instance","status": "$.detail.status"},
                "InputTemplate": "<instance> is in state <status>" 
              }
        }
    ]
}
```

### Example
<a name="API_PutTargets_Example_3"></a>

Here is another sample request using `InputTransformer`. The input to the Lambda function is in JSON format, with an array substituted. Below that sample request are examples of an event and the resulting output to the target, using this sample request.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "testrule", 
    "Targets": [
        {
            "Id": "MyTargetId", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" 
            "InputTransformer":
              {
                "InputPathsMap": {"commandsToRun": "$.detail.commands"},
                "InputTemplate": "{\"commands\": <commandsToRun>}" 
              }
        }
    ]
}
```

```
               Incoming event:
     
{
    "Time": 1225864800,
    "Source": "foo",
    "Resources": ["foo", "foo"],
    "DetailType": "foo",
    "Detail": {
        "commands": ["ls -lrt", "echo HelloWorld!"]
    }
}
```

```
               Output sent to the target:
     
{
    "commands" : ["ls -lrt", "echo HelloWorld!"]
}
```

### Sends a command to a list of EC2 instances specified by InstanceIds, using Amazon EC2 Run Command
<a name="API_PutTargets_Example_4"></a>

This example illustrates one usage of PutTargets.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "testrule", 
    "Targets": [
        {
            "Id": "id123456789",
            "Arn": "arn:aws:ssm:us-east-1:12345679012:document/RestartLinuxService",
            "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessEC2"
            "RunCommandParameters": {
                 "RunCommandTargets": [
                    {
                        "Key":"InstanceIds",
                        "Values":["i-123456789012", "i-098765432109"]
                    }
                                       ]
    }

    ]
}
```

### Sends a batch job command to an job queue
<a name="API_PutTargets_Example_5"></a>

When the target is an AWS Batch job queue, the `Arn` field specifies the ARN of the job queue, while `JobDefinition` specifies the ARN of the job definition.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
   "Rule":"batch-job-rule",
   "Targets":[
      {
         "Id":"id123456789",
         "Arn":"arn:aws:batch:us-west-2:012345678910:job-queue/default",
         "BatchParameters":{
            "ArrayProperties":{
               "Size":25
            },
            "JobDefinition":"arn:aws:batch:us-west-2:012345678910:job-definition/nvidia-smi:1",
            "JobName":"unique-job-name",
            "RetryStrategy":{
               "Attempts":5
            }
         }
      }
   ]
}
```

### Uses KinesisParameters to control the shard assignment
<a name="API_PutTargets_Example_6"></a>

In this example, `KinesisParameters` is used to specify that events related to status changes are sent to a shard specific to the affected instance ID.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "StatusChangeRule", 
    "Targets": [
           {
        "Id" : "1", 
        "Arn": "arn:aws:kinesis:us-east-1:123456789012:function:stream/mystream",
        "KinesisParameters":{
             "PartitionKeyPath":"$.detail.instance-id"}'
    }
]
}
```

### Adds an Amazon Data Firehose data delivery stream as a target
<a name="API_PutTargets_Example_7"></a>

This example sets a Kinesis data delivery stream named `target-stream-name` as a target.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "FirehoseExample", 
    "Targets": [
           {
        "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessKinesis"
        "Id" : "FirehoseStream", 
        "Arn": "arn:aws:firehose:us-east-1:123456789012:deliverystream/target-stream-name",
    }
]
}
```

### Adds a Step Functions state machine as a target
<a name="API_PutTargets_Example_8"></a>

This example targets a state machine called "HelloWorld", and sends the input constant "Hello World\$1" to that target.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "testrule", 
    "Targets": [
           {
        "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessStepFunctions"
        "Arn":"arn:aws:states:us-east-1:123456789012:stateMachine:HelloWorld",
        "Input":"HelloWorld!"
    }
]
}
```

### Adds a target that creates three Amazon ECS tasks based on a task definition
<a name="API_PutTargets_Example_9"></a>

This example uses Amazon ECS as the target. You must have already created the task definition and cluster in Amazon ECS.

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "test", 
    "Targets": [
        {
            "Id": "Target1",
            "RoleArn": "arn:aws:iam::123456789012:role/MyRoleToAccessECS"
            "Arn": "arn:aws:ecs:us-east-1:123456789012:cluster/example-cluster",
            "ECSParameters": {
                  "TaskDefinitionArn": "arn:aws:ecs:us-east-1:123456789012:task-definition/example",
                  "TaskCount": 3
             }
         }
    ]
}
```

### Specifying two targets with one command
<a name="API_PutTargets_Example_10"></a>

This example sets two simple targets with one command. In this example, both targets are AWS Lambda functions, but the two targets could be different AWS services as well.

#### Sample Request
<a name="API_PutTargets_Example_10_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "test", 
    "Targets": [
        {
            "Id": "MyTargetId", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" 
        }
        {
            "Id": "MyTargetId2", 
            "Arn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction2" 
        }
    ]
}
```

### Specifying another account as a target
<a name="API_PutTargets_Example_11"></a>

This example shows cross-account event delivery. The target being added is the event bus of a separate AWS account, which has the AWS account ID of `444455556666`.

**Note**  
 `Input`, `InputPath`, and `InputTransformer` are not available with `PutTarget` if the target is an event bus of a different AWS account.

#### Sample Request
<a name="API_PutTargets_Example_11_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
    "Rule": "producer-rule", 
    "Targets": [
        {
            "Id": "CrossAccountTargetId", 
            "Arn": "arn:aws:events:us-east-1:444455556666:event-bus/default" 
        }
   ]
}
```

### Adds a API Gateway API as a target
<a name="API_PutTargets_Example_12"></a>

This example targets an API Gateway API with static and dynamic HTTP parameters.

**Note**  
 HTTP parameters with static values are passed through to API Gateway as-is. If you provide a JSON Path (prefixed with "\$1."), it will be dynamically replaced at runtime with a value from the event payload (before input transformation). 

#### Sample Request
<a name="API_PutTargets_Example_12_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.PutTargets

{
 "Rule": "test",
 "Targets": 
  [
    {
     "Id": "testTargetId",
     "Arn": "arn:aws:execute-api:us-east-1:444455556666:py1kl011je/testStage/POST/path1/*/path2/*",
     "RoleArn": "arn:aws:iam::415653183693:role/APIGatewayPOC",
     "HttpParameters": 
      {
       "PathParameterValues": ["pp1Val", "pp2Val"],
       "HeaderParameters": {"hp1": "hp1Val", "hp2": "$.detail.header"},
       "QueryStringParameters": {"qsp1": "qsp1Val", "qsp2": "$.source"}
      }
    }
  ]
}
```

## See Also
<a name="API_PutTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/PutTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/PutTargets) 

# RemovePermission
<a name="API_RemovePermission"></a>

Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the `StatementId` value that you associated with the account when you granted it permission with `PutPermission`. You can find the `StatementId` by using [DescribeEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_DescribeEventBus.html).

## Request Syntax
<a name="API_RemovePermission_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "RemoveAllPermissions": boolean,
   "StatementId": "string"
}
```

## Request Parameters
<a name="API_RemovePermission_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_RemovePermission_RequestSyntax) **   <a name="eventbridge-RemovePermission-request-EventBusName"></a>
The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: No

 ** [RemoveAllPermissions](#API_RemovePermission_RequestSyntax) **   <a name="eventbridge-RemovePermission-request-RemoveAllPermissions"></a>
Specifies whether to remove all permissions.  
Type: Boolean  
Required: No

 ** [StatementId](#API_RemovePermission_RequestSyntax) **   <a name="eventbridge-RemovePermission-request-StatementId"></a>
The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[a-zA-Z0-9-_]+`   
Required: No

## Response Elements
<a name="API_RemovePermission_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_RemovePermission_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_RemovePermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/RemovePermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/RemovePermission) 

# RemoveTargets
<a name="API_RemoveTargets"></a>

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

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

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

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

The maximum number of entries per request is 10.

## Request Syntax
<a name="API_RemoveTargets_RequestSyntax"></a>

```
{
   "EventBusName": "string",
   "Force": boolean,
   "Ids": [ "string" ],
   "Rule": "string"
}
```

## Request Parameters
<a name="API_RemoveTargets_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [EventBusName](#API_RemoveTargets_RequestSyntax) **   <a name="eventbridge-RemoveTargets-request-EventBusName"></a>
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `(arn:aws[\w-]*:events:[a-z]+-[a-z]+-[\w-]+:[0-9]{12}:event-bus\/)?[/\.\-_A-Za-z0-9]+`   
Required: No

 ** [Force](#API_RemoveTargets_RequestSyntax) **   <a name="eventbridge-RemoveTargets-request-Force"></a>
If this is a managed rule, created by an AWS 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.  
Type: Boolean  
Required: No

 ** [Ids](#API_RemoveTargets_RequestSyntax) **   <a name="eventbridge-RemoveTargets-request-Ids"></a>
The IDs of the targets to remove from the rule.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [Rule](#API_RemoveTargets_RequestSyntax) **   <a name="eventbridge-RemoveTargets-request-Rule"></a>
The name of the rule.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_RemoveTargets_ResponseSyntax"></a>

```
{
   "FailedEntries": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "TargetId": "string"
      }
   ],
   "FailedEntryCount": number
}
```

## Response Elements
<a name="API_RemoveTargets_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [FailedEntries](#API_RemoveTargets_ResponseSyntax) **   <a name="eventbridge-RemoveTargets-response-FailedEntries"></a>
The failed target entries.  
Type: Array of [RemoveTargetsResultEntry](API_RemoveTargetsResultEntry.md) objects

 ** [FailedEntryCount](#API_RemoveTargets_ResponseSyntax) **   <a name="eventbridge-RemoveTargets-response-FailedEntryCount"></a>
The number of failed entries.  
Type: Integer

## Errors
<a name="API_RemoveTargets_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_RemoveTargets_Examples"></a>

### Removes a target with ID "MyTargetId" from a rule named "test"
<a name="API_RemoveTargets_Example_1"></a>

The following is an example of a RemoveTargets request.

#### Sample Request
<a name="API_RemoveTargets_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.RemoveTargets

{
    "Rule": "test", 
    "Ids": [
        "MyTargetId"
    ]
}
```

#### Sample Response
<a name="API_RemoveTargets_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "FailedEntries": [],
    "FailedEntryCount": 0
}
```

## See Also
<a name="API_RemoveTargets_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/RemoveTargets) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/RemoveTargets) 

# StartReplay
<a name="API_StartReplay"></a>

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

## Request Syntax
<a name="API_StartReplay_RequestSyntax"></a>

```
{
   "Description": "string",
   "Destination": { 
      "Arn": "string",
      "FilterArns": [ "string" ]
   },
   "EventEndTime": number,
   "EventSourceArn": "string",
   "EventStartTime": number,
   "ReplayName": "string"
}
```

## Request Parameters
<a name="API_StartReplay_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-Description"></a>
A description for the replay to start.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [Destination](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-Destination"></a>
A `ReplayDestination` object that includes details about the destination for the replay.  
Type: [ReplayDestination](API_ReplayDestination.md) object  
Required: Yes

 ** [EventEndTime](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-EventEndTime"></a>
A time stamp for the time to stop replaying events. Only events that occurred between the `EventStartTime` and `EventEndTime` are replayed.  
Type: Timestamp  
Required: Yes

 ** [EventSourceArn](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-EventSourceArn"></a>
The ARN of the archive to replay events from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$`   
Required: Yes

 ** [EventStartTime](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-EventStartTime"></a>
A time stamp for the time to start replaying events. Only events that occurred between the `EventStartTime` and `EventEndTime` are replayed.  
Type: Timestamp  
Required: Yes

 ** [ReplayName](#API_StartReplay_RequestSyntax) **   <a name="eventbridge-StartReplay-request-ReplayName"></a>
The name of the replay to start.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_StartReplay_ResponseSyntax"></a>

```
{
   "ReplayArn": "string",
   "ReplayStartTime": number,
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_StartReplay_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ReplayArn](#API_StartReplay_ResponseSyntax) **   <a name="eventbridge-StartReplay-response-ReplayArn"></a>
The ARN of the replay.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$` 

 ** [ReplayStartTime](#API_StartReplay_ResponseSyntax) **   <a name="eventbridge-StartReplay-response-ReplayStartTime"></a>
The time at which the replay started.  
Type: Timestamp

 ** [State](#API_StartReplay_ResponseSyntax) **   <a name="eventbridge-StartReplay-response-State"></a>
The state of the replay.  
Type: String  
Valid Values: `STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED` 

 ** [StateReason](#API_StartReplay_ResponseSyntax) **   <a name="eventbridge-StartReplay-response-StateReason"></a>
The reason that the replay is in the state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_StartReplay_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidEventPatternException **   
The event pattern is not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceAlreadyExistsException **   
The resource you are trying to create already exists.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_StartReplay_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/StartReplay) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/StartReplay) 

# TagResource
<a name="API_TagResource"></a>

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.

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

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

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

## Request Syntax
<a name="API_TagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}
```

## Request Parameters
<a name="API_TagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_TagResource_RequestSyntax) **   <a name="eventbridge-TagResource-request-ResourceARN"></a>
The ARN of the EventBridge resource that you're adding tags to.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

 ** [Tags](#API_TagResource_RequestSyntax) **   <a name="eventbridge-TagResource-request-Tags"></a>
The list of key-value pairs to associate with the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: Yes

## Response Elements
<a name="API_TagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_TagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_TagResource_Examples"></a>

### Adds two tags to a EventBridge rule
<a name="API_TagResource_Example_1"></a>

The following is an example of a `TagResource` request.

#### Sample Request
<a name="API_TagResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.TagResource

{
    "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",
    "Tags": [
        {
            "Key": "Stack",
            "Value": "Prod"
        },
        {
            "Key": "Team",
            "Value": "Green"
        }
    ]
}
```

## See Also
<a name="API_TagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/TagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/TagResource) 

# TestEventPattern
<a name="API_TestEventPattern"></a>

Tests whether the specified event pattern matches the provided event.

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

## Request Syntax
<a name="API_TestEventPattern_RequestSyntax"></a>

```
{
   "Event": "string",
   "EventPattern": "string"
}
```

## Request Parameters
<a name="API_TestEventPattern_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Event](#API_TestEventPattern_RequestSyntax) **   <a name="eventbridge-TestEventPattern-request-Event"></a>
The event, in JSON format, to test against the event pattern. The JSON must follow the format specified in [AWS Events](https://docs.aws.amazon.com/eventbridge/latest/userguide/aws-events.html), and the following fields are mandatory:  
+  `id` 
+  `account` 
+  `source` 
+  `time` 
+  `region` 
+  `resources` 
+  `detail-type` 
Type: String  
Required: Yes

 ** [EventPattern](#API_TestEventPattern_RequestSyntax) **   <a name="eventbridge-TestEventPattern-request-EventPattern"></a>
The event pattern. For more information, see [Events and Event Patterns](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) in the * *Amazon EventBridge User Guide* *.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: Yes

## Response Syntax
<a name="API_TestEventPattern_ResponseSyntax"></a>

```
{
   "Result": boolean
}
```

## Response Elements
<a name="API_TestEventPattern_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Result](#API_TestEventPattern_ResponseSyntax) **   <a name="eventbridge-TestEventPattern-response-Result"></a>
Indicates whether the event matches the event pattern.  
Type: Boolean

## Errors
<a name="API_TestEventPattern_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidEventPatternException **   
The event pattern is not valid.  
HTTP Status Code: 400

## Examples
<a name="API_TestEventPattern_Examples"></a>

### Tests that a given event matches a given event pattern
<a name="API_TestEventPattern_Example_1"></a>

The following is an example of a TestEventPattern request and response.

#### Sample Request
<a name="API_TestEventPattern_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.TestEventPattern

{
    "EventPattern": "{\"source\": [\"com.mycompany.myapp\"]}",
    "Event": "{\"id\": \"e00c66cb-fe7a-4fcc-81ad-58eb60f5d96b\", \"detail-type\": \"myDetailType\", \"source\": \"com.mycompany.myapp\", \"account\": \"123456789012\", \"time\": \"2016-01-10T01:29:23Z\", \"region\": \"us-east-1\", \"resources\": [\"resource1\",  \"resource2\"], \"detail\": {\"key1\": \"value1\", \"key2\": \"value2\"}}"
  }
}
```

#### Sample Response
<a name="API_TestEventPattern_Example_1_Response"></a>

```
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>

{
    "Result": true
}
```

## See Also
<a name="API_TestEventPattern_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/TestEventPattern) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/TestEventPattern) 

# UntagResource
<a name="API_UntagResource"></a>

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

## Request Syntax
<a name="API_UntagResource_RequestSyntax"></a>

```
{
   "ResourceARN": "string",
   "TagKeys": [ "string" ]
}
```

## Request Parameters
<a name="API_UntagResource_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ResourceARN](#API_UntagResource_RequestSyntax) **   <a name="eventbridge-UntagResource-request-ResourceARN"></a>
The ARN of the EventBridge resource from which you are removing tags.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Required: Yes

 ** [TagKeys](#API_UntagResource_RequestSyntax) **   <a name="eventbridge-UntagResource-request-TagKeys"></a>
The list of tag keys to remove from the resource.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Required: Yes

## Response Elements
<a name="API_UntagResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

## Errors
<a name="API_UntagResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ManagedRuleException **   
This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to `DeleteRule` or `RemoveTargets`, you can use the `Force` parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using `DisableRule`, `EnableRule`, `PutTargets`, `PutRule`, `TagResource`, or `UntagResource`.   
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## Examples
<a name="API_UntagResource_Examples"></a>

### Removes two tags from an EventBridge rule
<a name="API_UntagResource_Example_1"></a>

The following is an example of an `UntagResource` request.

#### Sample Request
<a name="API_UntagResource_Example_1_Request"></a>

```
POST / HTTP/1.1
Host: events.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=content-type;date;host;user-agent;x-amz-date;x-amz-target;x-amzn-requestid, Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive 
X-Amz-Target: AWSEvents.UntagResource

{
    "ResourceARN": "arn:aws:events:us-west-1:123456789012:rule/test",
    "TagKeys": [ "CostCenter", "Team" ]
}
```

## See Also
<a name="API_UntagResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UntagResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UntagResource) 

# UpdateApiDestination
<a name="API_UpdateApiDestination"></a>

Updates an API destination.

## Request Syntax
<a name="API_UpdateApiDestination_RequestSyntax"></a>

```
{
   "ConnectionArn": "string",
   "Description": "string",
   "HttpMethod": "string",
   "InvocationEndpoint": "string",
   "InvocationRateLimitPerSecond": number,
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateApiDestination_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ConnectionArn](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-ConnectionArn"></a>
The ARN of the connection to use for the API destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$`   
Required: No

 ** [Description](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-Description"></a>
The name of the API destination to update.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [HttpMethod](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-HttpMethod"></a>
The method to use for the API destination.  
Type: String  
Valid Values: `POST | GET | HEAD | OPTIONS | PUT | PATCH | DELETE`   
Required: No

 ** [InvocationEndpoint](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-InvocationEndpoint"></a>
The URL to the endpoint to use for the API destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `^((%[0-9A-Fa-f]{2}|[-()_.!~*';/?:@\x26=+$,A-Za-z0-9])+)([).!';/?:,])?$`   
Required: No

 ** [InvocationRateLimitPerSecond](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-InvocationRateLimitPerSecond"></a>
The maximum number of invocations per second to send to the API destination.  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** [Name](#API_UpdateApiDestination_RequestSyntax) **   <a name="eventbridge-UpdateApiDestination-request-Name"></a>
The name of the API destination to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateApiDestination_ResponseSyntax"></a>

```
{
   "ApiDestinationArn": "string",
   "ApiDestinationState": "string",
   "CreationTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_UpdateApiDestination_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ApiDestinationArn](#API_UpdateApiDestination_ResponseSyntax) **   <a name="eventbridge-UpdateApiDestination-response-ApiDestinationArn"></a>
The ARN of the API destination that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:api-destination\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ApiDestinationState](#API_UpdateApiDestination_ResponseSyntax) **   <a name="eventbridge-UpdateApiDestination-response-ApiDestinationState"></a>
The state of the API destination that was updated.  
Type: String  
Valid Values: `ACTIVE | INACTIVE` 

 ** [CreationTime](#API_UpdateApiDestination_ResponseSyntax) **   <a name="eventbridge-UpdateApiDestination-response-CreationTime"></a>
A time stamp for the time that the API destination was created.  
Type: Timestamp

 ** [LastModifiedTime](#API_UpdateApiDestination_ResponseSyntax) **   <a name="eventbridge-UpdateApiDestination-response-LastModifiedTime"></a>
A time stamp for the time that the API destination was last modified.  
Type: Timestamp

## Errors
<a name="API_UpdateApiDestination_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateApiDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UpdateApiDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UpdateApiDestination) 

# UpdateArchive
<a name="API_UpdateArchive"></a>

Updates the specified archive.

## Request Syntax
<a name="API_UpdateArchive_RequestSyntax"></a>

```
{
   "ArchiveName": "string",
   "Description": "string",
   "EventPattern": "string",
   "KmsKeyIdentifier": "string",
   "RetentionDays": number
}
```

## Request Parameters
<a name="API_UpdateArchive_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ArchiveName](#API_UpdateArchive_RequestSyntax) **   <a name="eventbridge-UpdateArchive-request-ArchiveName"></a>
The name of the archive to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [Description](#API_UpdateArchive_RequestSyntax) **   <a name="eventbridge-UpdateArchive-request-Description"></a>
The description for the archive.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [EventPattern](#API_UpdateArchive_RequestSyntax) **   <a name="eventbridge-UpdateArchive-request-EventPattern"></a>
The event pattern to use to filter events sent to the archive.  
Type: String  
Length Constraints: Maximum length of 4096.  
Required: No

 ** [KmsKeyIdentifier](#API_UpdateArchive_RequestSyntax) **   <a name="eventbridge-UpdateArchive-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the archive.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.   
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [RetentionDays](#API_UpdateArchive_RequestSyntax) **   <a name="eventbridge-UpdateArchive-request-RetentionDays"></a>
The number of days to retain events in the archive.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## Response Syntax
<a name="API_UpdateArchive_ResponseSyntax"></a>

```
{
   "ArchiveArn": "string",
   "CreationTime": number,
   "State": "string",
   "StateReason": "string"
}
```

## Response Elements
<a name="API_UpdateArchive_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ArchiveArn](#API_UpdateArchive_ResponseSyntax) **   <a name="eventbridge-UpdateArchive-response-ArchiveArn"></a>
The ARN of the archive.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/.+$` 

 ** [CreationTime](#API_UpdateArchive_ResponseSyntax) **   <a name="eventbridge-UpdateArchive-response-CreationTime"></a>
The time at which the archive was updated.  
Type: Timestamp

 ** [State](#API_UpdateArchive_ResponseSyntax) **   <a name="eventbridge-UpdateArchive-response-State"></a>
The state of the archive.  
Type: String  
Valid Values: `ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED` 

 ** [StateReason](#API_UpdateArchive_ResponseSyntax) **   <a name="eventbridge-UpdateArchive-response-StateReason"></a>
The reason that the archive is in the current state.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*` 

## Errors
<a name="API_UpdateArchive_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** InvalidEventPatternException **   
The event pattern is not valid.  
HTTP Status Code: 400

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateArchive_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UpdateArchive) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UpdateArchive) 

# UpdateConnection
<a name="API_UpdateConnection"></a>

Updates settings for a connection.

## Request Syntax
<a name="API_UpdateConnection_RequestSyntax"></a>

```
{
   "AuthorizationType": "string",
   "AuthParameters": { 
      "ApiKeyAuthParameters": { 
         "ApiKeyName": "string",
         "ApiKeyValue": "string"
      },
      "BasicAuthParameters": { 
         "Password": "string",
         "Username": "string"
      },
      "ConnectivityParameters": { 
         "ResourceParameters": { 
            "ResourceConfigurationArn": "string"
         }
      },
      "InvocationHttpParameters": { 
         "BodyParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "HeaderParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ],
         "QueryStringParameters": [ 
            { 
               "IsValueSecret": boolean,
               "Key": "string",
               "Value": "string"
            }
         ]
      },
      "OAuthParameters": { 
         "AuthorizationEndpoint": "string",
         "ClientParameters": { 
            "ClientID": "string",
            "ClientSecret": "string"
         },
         "HttpMethod": "string",
         "OAuthHttpParameters": { 
            "BodyParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "HeaderParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ],
            "QueryStringParameters": [ 
               { 
                  "IsValueSecret": boolean,
                  "Key": "string",
                  "Value": "string"
               }
            ]
         }
      }
   },
   "Description": "string",
   "InvocationConnectivityParameters": { 
      "ResourceParameters": { 
         "ResourceConfigurationArn": "string"
      }
   },
   "KmsKeyIdentifier": "string",
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateConnection_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [AuthorizationType](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-AuthorizationType"></a>
The type of authorization to use for the connection.  
Type: String  
Valid Values: `BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY`   
Required: No

 ** [AuthParameters](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-AuthParameters"></a>
The authorization parameters to use for the connection.  
Type: [UpdateConnectionAuthRequestParameters](API_UpdateConnectionAuthRequestParameters.md) object  
Required: No

 ** [Description](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-Description"></a>
A description for the connection.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [InvocationConnectivityParameters](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-InvocationConnectivityParameters"></a>
For connections to private APIs, the parameters to use for invoking the API.  
For more information, see [Connecting to private APIs](https://docs.aws.amazon.com/eventbridge/latest/userguide/connection-private.html) in the * *Amazon EventBridge User Guide* *.  
Type: [ConnectivityResourceParameters](API_ConnectivityResourceParameters.md) object  
Required: No

 ** [KmsKeyIdentifier](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [Name](#API_UpdateConnection_RequestSyntax) **   <a name="eventbridge-UpdateConnection-request-Name"></a>
The name of the connection to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

## Response Syntax
<a name="API_UpdateConnection_ResponseSyntax"></a>

```
{
   "ConnectionArn": "string",
   "ConnectionState": "string",
   "CreationTime": number,
   "LastAuthorizedTime": number,
   "LastModifiedTime": number
}
```

## Response Elements
<a name="API_UpdateConnection_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [ConnectionArn](#API_UpdateConnection_ResponseSyntax) **   <a name="eventbridge-UpdateConnection-response-ConnectionArn"></a>
The ARN of the connection that was updated.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$` 

 ** [ConnectionState](#API_UpdateConnection_ResponseSyntax) **   <a name="eventbridge-UpdateConnection-response-ConnectionState"></a>
The state of the connection that was updated.  
Type: String  
Valid Values: `CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING | ACTIVE | FAILED_CONNECTIVITY` 

 ** [CreationTime](#API_UpdateConnection_ResponseSyntax) **   <a name="eventbridge-UpdateConnection-response-CreationTime"></a>
A time stamp for the time that the connection was created.  
Type: Timestamp

 ** [LastAuthorizedTime](#API_UpdateConnection_ResponseSyntax) **   <a name="eventbridge-UpdateConnection-response-LastAuthorizedTime"></a>
A time stamp for the time that the connection was last authorized.  
Type: Timestamp

 ** [LastModifiedTime](#API_UpdateConnection_ResponseSyntax) **   <a name="eventbridge-UpdateConnection-response-LastModifiedTime"></a>
A time stamp for the time that the connection was last modified.  
Type: Timestamp

## Errors
<a name="API_UpdateConnection_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You do not have the necessary permissions for this action.  
HTTP Status Code: 400

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** LimitExceededException **   
The request failed because it attempted to create resource beyond the allowed service quota.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

 ** ThrottlingException **   
This request cannot be completed due to throttling issues.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UpdateConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UpdateConnection) 

# UpdateEndpoint
<a name="API_UpdateEndpoint"></a>

Update an existing endpoint. For more information about global endpoints, see [Making applications Regional-fault tolerant with global endpoints and event replication](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-global-endpoints.html) in the * *Amazon EventBridge User Guide* *.

## Request Syntax
<a name="API_UpdateEndpoint_RequestSyntax"></a>

```
{
   "Description": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   }
}
```

## Request Parameters
<a name="API_UpdateEndpoint_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [Description](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-Description"></a>
A description for the endpoint.  
Type: String  
Length Constraints: Maximum length of 512.  
Pattern: `.*`   
Required: No

 ** [EventBuses](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-EventBuses"></a>
Define event buses used for replication.  
Type: Array of [EndpointEventBus](API_EndpointEventBus.md) objects  
Array Members: Fixed number of 2 items.  
Required: No

 ** [Name](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-Name"></a>
The name of the endpoint you want to update.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+`   
Required: Yes

 ** [ReplicationConfig](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-ReplicationConfig"></a>
Whether event replication was enabled or disabled by this request.  
Type: [ReplicationConfig](API_ReplicationConfig.md) object  
Required: No

 ** [RoleArn](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-RoleArn"></a>
The ARN of the role used by event replication for this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$`   
Required: No

 ** [RoutingConfig](#API_UpdateEndpoint_RequestSyntax) **   <a name="eventbridge-UpdateEndpoint-request-RoutingConfig"></a>
Configure the routing policy, including the health check and secondary Region.  
Type: [RoutingConfig](API_RoutingConfig.md) object  
Required: No

## Response Syntax
<a name="API_UpdateEndpoint_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "EndpointId": "string",
   "EndpointUrl": "string",
   "EventBuses": [ 
      { 
         "EventBusArn": "string"
      }
   ],
   "Name": "string",
   "ReplicationConfig": { 
      "State": "string"
   },
   "RoleArn": "string",
   "RoutingConfig": { 
      "FailoverConfig": { 
         "Primary": { 
            "HealthCheck": "string"
         },
         "Secondary": { 
            "Route": "string"
         }
      }
   },
   "State": "string"
}
```

## Response Elements
<a name="API_UpdateEndpoint_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-Arn"></a>
The ARN of the endpoint you updated in this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1600.  
Pattern: `^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:endpoint\/[/\.\-_A-Za-z0-9]+$` 

 ** [EndpointId](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-EndpointId"></a>
The ID of the endpoint you updated in this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `^[A-Za-z0-9\-]+[\.][A-Za-z0-9\-]+$` 

 ** [EndpointUrl](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-EndpointUrl"></a>
The URL of the endpoint you updated in this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^(https://)?[\.\-a-z0-9]+$` 

 ** [EventBuses](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-EventBuses"></a>
The event buses used for replication for the endpoint you updated in this request.  
Type: Array of [EndpointEventBus](API_EndpointEventBus.md) objects  
Array Members: Fixed number of 2 items.

 ** [Name](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-Name"></a>
The name of the endpoint you updated in this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `[\.\-_A-Za-z0-9]+` 

 ** [ReplicationConfig](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-ReplicationConfig"></a>
Whether event replication was enabled or disabled for the endpoint you updated in this request.  
Type: [ReplicationConfig](API_ReplicationConfig.md) object

 ** [RoleArn](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-RoleArn"></a>
The ARN of the role used by event replication for the endpoint you updated in this request.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^arn:aws[a-z-]*:iam::\d{12}:role\/[\w+=,.@/-]+$` 

 ** [RoutingConfig](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-RoutingConfig"></a>
The routing configuration you updated in this request.  
Type: [RoutingConfig](API_RoutingConfig.md) object

 ** [State](#API_UpdateEndpoint_ResponseSyntax) **   <a name="eventbridge-UpdateEndpoint-response-State"></a>
The state of the endpoint you updated in this request.  
Type: String  
Valid Values: `ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED` 

## Errors
<a name="API_UpdateEndpoint_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UpdateEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UpdateEndpoint) 

# UpdateEventBus
<a name="API_UpdateEventBus"></a>

Updates the specified event bus.

## Request Syntax
<a name="API_UpdateEventBus_RequestSyntax"></a>

```
{
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "KmsKeyIdentifier": "string",
   "LogConfig": { 
      "IncludeDetail": "string",
      "Level": "string"
   },
   "Name": "string"
}
```

## Request Parameters
<a name="API_UpdateEventBus_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DeadLetterConfig](#API_UpdateEventBus_RequestSyntax) **   <a name="eventbridge-UpdateEventBus-request-DeadLetterConfig"></a>
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).  
For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide*.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object  
Required: No

 ** [Description](#API_UpdateEventBus_RequestSyntax) **   <a name="eventbridge-UpdateEventBus-request-Description"></a>
The event bus description.  
Type: String  
Length Constraints: Maximum length of 512.  
Required: No

 ** [KmsKeyIdentifier](#API_UpdateEventBus_RequestSyntax) **   <a name="eventbridge-UpdateEventBus-request-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.  
If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt events on the event bus.  
For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the * AWS Key Management Service Developer Guide*.   
Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:   
+ You call ` [CreateDiscoverer](https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer) ` on an event bus set to use a customer managed key for encryption.
+ You call ` [UpdatedEventBus](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html) ` to set a customer managed key on an event bus with schema discovery enabled.
To enable schema discovery on an event bus, choose to use an AWS owned key. For more information, see [Encrypting events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption-event-bus-cmkey.html) in the *Amazon EventBridge User Guide*.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.   
For more information, see [Encrypting archives](https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html) in the *Amazon EventBridge User Guide*.
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$`   
Required: No

 ** [LogConfig](#API_UpdateEventBus_RequestSyntax) **   <a name="eventbridge-UpdateEventBus-request-LogConfig"></a>
The logging configuration settings for the event bus.  
For more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) in the *EventBridge User Guide*.  
Type: [LogConfig](API_LogConfig.md) object  
Required: No

 ** [Name](#API_UpdateEventBus_RequestSyntax) **   <a name="eventbridge-UpdateEventBus-request-Name"></a>
The name of the event bus.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+`   
Required: No

## Response Syntax
<a name="API_UpdateEventBus_ResponseSyntax"></a>

```
{
   "Arn": "string",
   "DeadLetterConfig": { 
      "Arn": "string"
   },
   "Description": "string",
   "KmsKeyIdentifier": "string",
   "LogConfig": { 
      "IncludeDetail": "string",
      "Level": "string"
   },
   "Name": "string"
}
```

## Response Elements
<a name="API_UpdateEventBus_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [Arn](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-Arn"></a>
The event bus Amazon Resource Name (ARN).  
Type: String

 ** [DeadLetterConfig](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-DeadLetterConfig"></a>
Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).  
For more information, see [Using dead-letter queues to process undelivered events](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq) in the *EventBridge User Guide*.  
Type: [DeadLetterConfig](API_DeadLetterConfig.md) object

 ** [Description](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-Description"></a>
The event bus description.  
Type: String  
Length Constraints: Maximum length of 512.

 ** [KmsKeyIdentifier](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-KmsKeyIdentifier"></a>
The identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified.  
For more information, see [Data encryption in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html) in the *Amazon EventBridge User Guide*.  
Type: String  
Length Constraints: Maximum length of 2048.  
Pattern: `^[a-zA-Z0-9_\-/:]*$` 

 ** [LogConfig](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-LogConfig"></a>
The logging configuration settings for the event bus.  
For more information, see [Configuring logs for event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) in the *EventBridge User Guide*.  
Type: [LogConfig](API_LogConfig.md) object

 ** [Name](#API_UpdateEventBus_ResponseSyntax) **   <a name="eventbridge-UpdateEventBus-response-Name"></a>
The event bus name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[/\.\-_A-Za-z0-9]+` 

## Errors
<a name="API_UpdateEventBus_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** ConcurrentModificationException **   
There is concurrent modification on a rule, target, archive, or replay.  
HTTP Status Code: 400

 ** InternalException **   
This exception occurs due to unexpected causes.  
HTTP Status Code: 500

 ** OperationDisabledException **   
The operation you are attempting is not available in this region.  
HTTP Status Code: 400

 ** ResourceNotFoundException **   
An entity that you specified does not exist.  
HTTP Status Code: 400

## See Also
<a name="API_UpdateEventBus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/eventbridge-2015-10-07/UpdateEventBus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/eventbridge-2015-10-07/UpdateEventBus)