/AWS1/CL_CWEDESCRAPIDSTRSP¶
DescribeApiDestinationResponse
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_APIDESTINATIONARN TYPE /AWS1/CWEAPIDESTINATIONARN /AWS1/CWEAPIDESTINATIONARN¶
The ARN of the API destination retrieved.
IV_NAME TYPE /AWS1/CWEAPIDESTINATIONNAME /AWS1/CWEAPIDESTINATIONNAME¶
The name of the API destination retrieved.
IV_DESCRIPTION TYPE /AWS1/CWEAPIDSTDESCRIPTION /AWS1/CWEAPIDSTDESCRIPTION¶
The description for the API destination retrieved.
IV_APIDESTINATIONSTATE TYPE /AWS1/CWEAPIDESTINATIONSTATE /AWS1/CWEAPIDESTINATIONSTATE¶
The state of the API destination retrieved.
IV_CONNECTIONARN TYPE /AWS1/CWECONNECTIONARN /AWS1/CWECONNECTIONARN¶
The ARN of the connection specified for the API destination retrieved.
IV_INVOCATIONENDPOINT TYPE /AWS1/CWEHTTPSENDPOINT /AWS1/CWEHTTPSENDPOINT¶
The URL to use to connect to the HTTP endpoint.
IV_HTTPMETHOD TYPE /AWS1/CWEAPIDSTHTTPMETHOD /AWS1/CWEAPIDSTHTTPMETHOD¶
The method to use to connect to the HTTP endpoint.
IV_INVCRATELIMITPERSECOND TYPE /AWS1/CWEAPIDSTINVCRLIMPERSEC /AWS1/CWEAPIDSTINVCRLIMPERSEC¶
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.
IV_CREATIONTIME TYPE /AWS1/CWETIMESTAMP /AWS1/CWETIMESTAMP¶
A time stamp for the time that the API destination was created.
IV_LASTMODIFIEDTIME TYPE /AWS1/CWETIMESTAMP /AWS1/CWETIMESTAMP¶
A time stamp for the time that the API destination was last modified.
Queryable Attributes¶
ApiDestinationArn¶
The ARN of the API destination retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIDESTINATIONARN() |
Getter for APIDESTINATIONARN, with configurable default |
ASK_APIDESTINATIONARN() |
Getter for APIDESTINATIONARN w/ exceptions if field has no v |
HAS_APIDESTINATIONARN() |
Determine if APIDESTINATIONARN has a value |
Name¶
The name of the API destination retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
Description¶
The description for the API destination retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DESCRIPTION() |
Getter for DESCRIPTION, with configurable default |
ASK_DESCRIPTION() |
Getter for DESCRIPTION w/ exceptions if field has no value |
HAS_DESCRIPTION() |
Determine if DESCRIPTION has a value |
ApiDestinationState¶
The state of the API destination retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_APIDESTINATIONSTATE() |
Getter for APIDESTINATIONSTATE, with configurable default |
ASK_APIDESTINATIONSTATE() |
Getter for APIDESTINATIONSTATE w/ exceptions if field has no |
HAS_APIDESTINATIONSTATE() |
Determine if APIDESTINATIONSTATE has a value |
ConnectionArn¶
The ARN of the connection specified for the API destination retrieved.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTIONARN() |
Getter for CONNECTIONARN, with configurable default |
ASK_CONNECTIONARN() |
Getter for CONNECTIONARN w/ exceptions if field has no value |
HAS_CONNECTIONARN() |
Determine if CONNECTIONARN has a value |
InvocationEndpoint¶
The URL to use to connect to the HTTP endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INVOCATIONENDPOINT() |
Getter for INVOCATIONENDPOINT, with configurable default |
ASK_INVOCATIONENDPOINT() |
Getter for INVOCATIONENDPOINT w/ exceptions if field has no |
HAS_INVOCATIONENDPOINT() |
Determine if INVOCATIONENDPOINT has a value |
HttpMethod¶
The method to use to connect to the HTTP endpoint.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HTTPMETHOD() |
Getter for HTTPMETHOD, with configurable default |
ASK_HTTPMETHOD() |
Getter for HTTPMETHOD w/ exceptions if field has no value |
HAS_HTTPMETHOD() |
Determine if HTTPMETHOD has a value |
InvocationRateLimitPerSecond¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INVCRATELIMITPERSECOND() |
Getter for INVOCATIONRATELIMITPERSECOND, with configurable d |
ASK_INVCRATELIMITPERSECOND() |
Getter for INVOCATIONRATELIMITPERSECOND w/ exceptions if fie |
HAS_INVCRATELIMITPERSECOND() |
Determine if INVOCATIONRATELIMITPERSECOND has a value |
CreationTime¶
A time stamp for the time that the API destination was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
LastModifiedTime¶
A time stamp for the time that the API destination was last modified.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME, with configurable default |
ASK_LASTMODIFIEDTIME() |
Getter for LASTMODIFIEDTIME w/ exceptions if field has no va |
HAS_LASTMODIFIEDTIME() |
Determine if LASTMODIFIEDTIME has a value |