Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
Parameters:
-
subscription_name
(Optional[String], default:
None
)
–
The name of the Amazon DocumentDB event notification subscription that you want to describe.
-
filters
(Optional[FilterList], default:
None
)
–
This parameter is not currently supported.
-
max_records
(Optional[IntegerOptional], default:
None
)
–
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
-
marker
(Optional[String], default:
None
)
–
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Raises:
Source code in docs_src/capo_docdb/_services/doc_db.py
| def describe_event_subscriptions(
self,
*,
config_overrides: Optional[DocDBClientConfig] = None,
subscription_name: Optional["capo_docdb.types.string.String"] = None,
filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
max_records: Optional[
"capo_docdb.types.integer_optional.IntegerOptional"
] = None,
marker: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.event_subscriptions_message.EventSubscriptionsMessage":
"""<p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.</p> <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
Args:
subscription_name: <p>The name of the Amazon DocumentDB event notification subscription that you want to describe.</p>
filters: <p>This parameter is not currently supported.</p>
max_records: <p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
marker: <p>An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
Raises:
capo_docdb.errors.subscription_not_found_fault.SubscriptionNotFoundFault: <p>The subscription name does not exist. </p>
capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_docdb.types.describe_event_subscriptions_message.DescribeEventSubscriptionsMessage]",
) -> OperationResponse[
"capo_docdb.types.event_subscriptions_message.EventSubscriptionsMessage"
]:
import capo_docdb._operations.amazon_rd_sv19.describe_event_subscriptions
output, http_response = (
capo_docdb._operations.amazon_rd_sv19.describe_event_subscriptions.describe_event_subscriptions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeEventSubscriptions")
)
input_: capo_docdb.types.describe_event_subscriptions_message.DescribeEventSubscriptionsMessage = {}
if subscription_name is not None:
input_["subscription_name"] = subscription_name
if filters is not None:
input_["filters"] = filters
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|