Skip to content

describe_event_subscriptions async

describe_event_subscriptions(
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    subscription_name: Optional[String] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeEventSubscriptionsResponse

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

Parameters:

  • subscription_name (Optional[String], default: None ) –

    The name of the DMS event subscription to be described.

  • filters (Optional[FilterList], default: None ) –

    Filters applied to event subscriptions.

    Valid filter names: event-subscription-arn | event-subscription-id

  • 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 called a 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_database_migration_service/_services/async_database_migration_service.py
async def describe_event_subscriptions(
    self,
    *,
    config_overrides: Optional[AsyncDatabaseMigrationServiceClientConfig] = None,
    subscription_name: Optional[
        "capo_database_migration_service.types.string.String"
    ] = None,
    filters: Optional[
        "capo_database_migration_service.types.filter_list.FilterList"
    ] = None,
    max_records: Optional[
        "capo_database_migration_service.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_database_migration_service.types.string.String"] = None,
) -> "capo_database_migration_service.types.describe_event_subscriptions_response.DescribeEventSubscriptionsResponse":
    """<p>Lists all the event subscriptions for a customer account. The description of 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 <code>SubscriptionName</code>, this action lists the description for that subscription.</p>

    Args:
        subscription_name: <p>The name of the DMS event subscription to be described.</p>
        filters: <p>Filters applied to event subscriptions.</p> <p>Valid filter names: <code>event-subscription-arn</code> | <code>event-subscription-id</code> </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 called a 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_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_database_migration_service.types.describe_event_subscriptions_message.DescribeEventSubscriptionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_database_migration_service.types.describe_event_subscriptions_response.DescribeEventSubscriptionsResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.describe_event_subscriptions

        (
            output,
            http_response,
        ) = await capo_database_migration_service._operations.amazon_dm_sv20160101.describe_event_subscriptions.async_describe_event_subscriptions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEventSubscriptions")
    )
    input_: capo_database_migration_service.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output