Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeApiDestinationResponse

Hierarchy

Index

Properties

Optional ApiDestinationArn

ApiDestinationArn: undefined | string

The ARN of the API destination retrieved.

Optional ApiDestinationState

ApiDestinationState: ApiDestinationState | string

The state of the API destination retrieved.

Optional ConnectionArn

ConnectionArn: undefined | string

The ARN of the connection specified for the API destination retrieved.

Optional CreationTime

CreationTime: Date

A time stamp for the time that the API destination was created.

Optional Description

Description: undefined | string

The description for the API destination retrieved.

Optional HttpMethod

HttpMethod: ApiDestinationHttpMethod | string

The method to use to connect to the HTTP endpoint.

Optional InvocationEndpoint

InvocationEndpoint: undefined | string

The URL to use to connect to the HTTP endpoint.

Optional InvocationRateLimitPerSecond

InvocationRateLimitPerSecond: undefined | number

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.

Optional LastModifiedTime

LastModifiedTime: Date

A time stamp for the time that the API destination was last modified.

Optional Name

Name: undefined | string

The name of the API destination retrieved.