libica.openapi.libens.SubscriptionsApi¶

All URIs are relative to https://aps2.platform.illumina.com

Method	HTTP request	Description
create_subscription	POST /v1/subscriptions	Creates a subscription to an event type and defines how those events get delivered.
disable_subscription	DELETE /v1/subscriptions/{subscriptionId}	Given a subscription id, disables the specified subscription.
get_subscription	GET /v1/subscriptions/{subscriptionId}	Given a subscription id, returns information about that subscription.
list_subscriptions	GET /v1/subscriptions	Get a list of subscriptions.

create_subscription¶

Subscription create_subscription(body=body)

Creates a subscription to an event type and defines how those events get delivered.

Events can be delivered to AWS SQS, AWS SNS, or can be used to launch a WES workflow.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libens
from libica.openapi.libens.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libens.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libens.SubscriptionsApi(api_client)
    body = libica.openapi.libens.CreateSubscriptionRequest() # CreateSubscriptionRequest |  (optional)

    try:
        # Creates a subscription to an event type and defines how those events get delivered.
        api_response = api_instance.create_subscription(body=body)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SubscriptionsApi->create_subscription: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
body	CreateSubscriptionRequest		[optional]

Return type¶

Subscription

Authorization¶

Bearer

HTTP request headers¶

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
201	The subscription is created successfully.	-
400	An invalid or missing input parameter will result in a bad request.	-
401	The acting identity cannot be authenticated and authorized.	-
403	The acting identity is not authorized to subscribe to the given event type or deliver to the given delivery target.	-
409	The given delivery target is not valid or cannot be delivered to.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

disable_subscription¶

Subscription disable_subscription(subscription_id)

Given a subscription id, disables the specified subscription.

Given a subscription id, disables that subscription with the current JWT token’s tenant Id.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libens
from libica.openapi.libens.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libens.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libens.SubscriptionsApi(api_client)
    subscription_id = 'subscription_id_example' # str | Id of the subscription to be disabled

    try:
        # Given a subscription id, disables the specified subscription.
        api_response = api_instance.disable_subscription(subscription_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SubscriptionsApi->disable_subscription: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
subscription_id	str	Id of the subscription to be disabled

Return type¶

Subscription

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Subscription for the given ID is disabled successfully.	-
400	An invalid or missing input parameter will result in a bad request.	-
401	The acting identity cannot be authenticated and authorized.	-
403	The acting identity is not authorized to disable the subscription for the given ID.	-
404	Could not find a subscription for the given ID.	-
410	The subscription for the given ID has been disabled.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_subscription¶

Subscription get_subscription(subscription_id)

Given a subscription id, returns information about that subscription.

Given a subscription id, returns information about that subscription accessible by the current JWT token’s tenant Id.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libens
from libica.openapi.libens.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libens.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libens.SubscriptionsApi(api_client)
    subscription_id = 'subscription_id_example' # str | Id of the subscription to return

    try:
        # Given a subscription id, returns information about that subscription.
        api_response = api_instance.get_subscription(subscription_id)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SubscriptionsApi->get_subscription: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
subscription_id	str	Id of the subscription to return

Return type¶

Subscription

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Subscription for the given ID is found and returned successfully.	-
400	An invalid or missing input parameter will result in a bad request.	-
401	The acting identity cannot be authenticated and authorized.	-
403	The acting identity is not authorized to access the subscription for the given ID.	-
404	Could not find a subscription for the given ID.	-
410	The subscription for the given ID has been disabled.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_subscriptions¶

SubscriptionList list_subscriptions(event_type=event_type, page_size=page_size, page_token=page_token)

Get a list of subscriptions.

Get a list of subscriptions accessible by the current JWT token’s tenant Id.

Example¶

Api Key Authentication (Bearer):

from __future__ import print_function
import time
import libica.openapi.libens
from libica.openapi.libens.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://aps2.platform.illumina.com
# See configuration.py for a list of all supported configuration parameters.
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Bearer
configuration = libica.openapi.libens.Configuration(
    host = "https://aps2.platform.illumina.com",
    api_key = {
        'Authorization': 'YOUR_API_KEY'
    }
)
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with libica.openapi.libens.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = libica.openapi.libens.SubscriptionsApi(api_client)
    event_type = 'event_type_example' # str | Optional event type for filtering returned subscriptions (optional)
page_size = 56 # int | Optional parameter to define the page size returned. Valid inputs range from 1-1000. (optional)
page_token = 'page_token_example' # str | Utilized for navigation after initial listing. Valid values include those of  firstPageToken, nextPageToken, and previousPageToken in the list response.  When there are no more pages, the nextPageToken will be null. (optional)

    try:
        # Get a list of subscriptions.
        api_response = api_instance.list_subscriptions(event_type=event_type, page_size=page_size, page_token=page_token)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SubscriptionsApi->list_subscriptions: %s\n" % e)

Parameters¶

Name	Type	Description	Notes
event_type	str	Optional event type for filtering returned subscriptions	[optional]
page_size	int	Optional parameter to define the page size returned. Valid inputs range from 1-1000.	[optional]
page_token	str	Utilized for navigation after initial listing. Valid values include those of firstPageToken, nextPageToken, and previousPageToken in the list response. When there are no more pages, the nextPageToken will be null.	[optional]

Return type¶

SubscriptionList

Authorization¶

Bearer

HTTP request headers¶

Content-Type: Not defined
Accept: application/json

HTTP response details¶

Status code	Description	Response headers
200	Subscriptions found and returned successfully.	-
400	An invalid or missing input parameter will result in a bad request.	-
401	The acting identity cannot be authenticated and authorized.	-
403	The acting identity is not authorized to access subscriptions.	-
0	Unexpected issue. Please try your request again. If problem persists, please contact the system administrator.	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]