Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeEventSource

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

Request Syntax


{
   "Name": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Name

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


{
   "Arn": "string",
   "CreatedBy": "string",
   "CreationTime": number,
   "ExpirationTime": number,
   "Name": "string",
   "State": "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.

Arn

The ARN of the partner event source.

Type: String

CreatedBy

The name of the SaaS partner that created the event source.

Type: String

CreationTime

The date and time that the event source was created.

Type: Timestamp

ExpirationTime

The date and time that the event source will expire if you do not create a matching event bus.

Type: Timestamp

Name

The name of the partner event source.

Type: String

State

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

For information about the errors that are common to all actions, see Common Errors.

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