For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateArchive
CreateArchive
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.
Request Syntax
{ "ArchiveName": "string", "Description": "string", "EventPattern": "string", "EventSourceArn": "string", "RetentionDays": number }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
ArchiveName (p. 12)
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 (p. 12)
A description for the archive.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: No EventPattern (p. 12)
An event pattern to use to filter events sent to the archive.
Type: String Required: No EventSourceArn (p. 12)
The ARN of the event bus that sends events to the archive.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: Yes RetentionDays (p. 12)
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
{ "ArchiveArn": "string", "CreationTime": number, "State": "string", "StateReason": "string"
}
Response Elements
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 (p. 13)
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 (p. 13)
The time at which the archive was created.
Type: Timestamp State (p. 13)
The state of the archive that was created.
Type: String
Valid Values: ENABLED | DISABLED | CREATING | UPDATING | CREATE_FAILED | UPDATE_FAILED
StateReason (p. 13)
The reason that the archive is in the state.
Type: String
Errors
Length Constraints: Maximum length of 512.
Pattern: .*
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateConnection
CreateConnection
Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
Request Syntax
{ "AuthorizationType": "string", "AuthParameters": {
"ApiKeyAuthParameters": {
"InvocationHttpParameters": { "BodyParameters": [
"AuthorizationEndpoint": "string", "ClientParameters": {
Request Parameters
"Description": "string", "Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
AuthorizationType (p. 15)
The type of authorization to use for the connection.
Type: String
Valid Values: BASIC | OAUTH_CLIENT_CREDENTIALS | API_KEY Required: Yes
AuthParameters (p. 15)
A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
Type: CreateConnectionAuthRequestParameters (p. 194) object Required: Yes
Description (p. 15)
A description for the connection to create.
Type: String
Length Constraints: Maximum length of 512.
Pattern: .*
Required: No Name (p. 15)
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
Response Syntax
{
"ConnectionArn": "string", "ConnectionState": "string", "CreationTime": number, "LastModifiedTime": number }
Response Elements
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 (p. 17)
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 (p. 17)
The state of the connection that was created by the request.
Type: String
Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING
CreationTime (p. 17)
A time stamp for the time that the connection was created.
Type: Timestamp LastModifiedTime (p. 17)
A time stamp for the time that the connection was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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.
See Also
HTTP Status Code: 400 ResourceAlreadyExistsException
The resource you are trying to create already exists.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreateEventBus
CreateEventBus
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
{ "EventSourceName": "string", "Name": "string",
"Tags": [ {
"Key": "string", "Value": "string"
} ]}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
EventSourceName (p. 19)
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 Name (p. 19)
The name of the new event bus.
Event bus names cannot contain the / character. You can't use the name default for a custom event bus, as this name is already used for your account's default event bus.
If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: [/\.\-_A-Za-z0-9]+
Required: Yes Tags (p. 19)
Tags to associate with the event bus.
Response Syntax
Type: Array of Tag (p. 236) objects Required: No
Response Syntax
{ "EventBusArn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
EventBusArn (p. 20)
The ARN of the new event bus.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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.
See Also
HTTP Status Code: 400 ResourceNotFoundException
An entity that you specified does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreatePartnerEventSource
CreatePartnerEventSource
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_name is determined during partner registration and identifies the partner to AWS customers.
event_namespace is determined by the partner and is a way for the partner to categorize their events.
event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.
Request Syntax
{ "Account": "string", "Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
Account (p. 22)
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 (p. 22)
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.
Response Syntax
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: aws\.partner(/[\.\-_A-Za-z0-9]+){2,}
Required: Yes
Response Syntax
{ "EventSourceArn": "string"
}
Response Elements
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 (p. 23)
The ARN of the partner event source.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeactivateEventSource
DeactivateEventSource
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.
Request Syntax
{
"Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
Name (p. 25)
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
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeauthorizeConnection
DeauthorizeConnection
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
{ "Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
Name (p. 27)
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
{
"ConnectionArn": "string", "ConnectionState": "string", "CreationTime": number, "LastAuthorizedTime": number, "LastModifiedTime": number }
Response Elements
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 (p. 27)
The ARN of the connection that authorization was removed from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Errors
Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:connection\/
[\.\-_A-Za-z0-9]+\/[\-A-Za-z0-9]+$
ConnectionState (p. 27) The state of the connection.
Type: String
Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING
CreationTime (p. 27)
A time stamp for the time that the connection was created.
Type: Timestamp LastAuthorizedTime (p. 27)
A time stamp for the time that the connection was last authorized.
Type: Timestamp LastModifiedTime (p. 27)
A time stamp for the time that the connection was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
See Also
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteApiDestination
DeleteApiDestination
Deletes the specified API destination.
Request Syntax
{ "Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
Name (p. 30)
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
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteArchive
DeleteArchive
Deletes the specified archive.
Request Syntax
{ "ArchiveName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
ArchiveName (p. 32)
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
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteConnection
DeleteConnection
Deletes a connection.
Request Syntax
{
"Name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 247).
The request accepts the following data in JSON format.
Name (p. 34)
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
{
"ConnectionArn": "string", "ConnectionState": "string", "CreationTime": number, "LastAuthorizedTime": number, "LastModifiedTime": number }
Response Elements
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 (p. 34)
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]+$
Errors
ConnectionState (p. 34)
The state of the connection before it was deleted.
Type: String
Valid Values: CREATING | UPDATING | DELETING | AUTHORIZED | DEAUTHORIZED | AUTHORIZING | DEAUTHORIZING
CreationTime (p. 34)
A time stamp for the time that the connection was created.
Type: Timestamp LastAuthorizedTime (p. 34)
A time stamp for the time that the connection was last authorized before it wa deleted.
Type: Timestamp LastModifiedTime (p. 34)
A time stamp for the time that the connection was last modified before it was deleted.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors (p. 249).
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
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
See Also
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteEventBus
DeleteEventBus
Deletes the specified custom event bus or partner event bus. All rules associated with this event bus
Deletes the specified custom event bus or partner event bus. All rules associated with this event bus