fastly.LoggingKinesisApi

Note

All URIs are relative to https://api.fastly.com

Method	HTTP request	Description
create_log_kinesis	POST /service/{service_id}/version/{version_id}/logging/kinesis	Create an Amazon Kinesis log endpoint
delete_log_kinesis	DELETE /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Delete the Amazon Kinesis log endpoint
get_log_kinesis	GET /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Get an Amazon Kinesis log endpoint
list_log_kinesis	GET /service/{service_id}/version/{version_id}/logging/kinesis	List Amazon Kinesis log endpoints
update_log_kinesis	PUT /service/{service_id}/version/{version_id}/logging/kinesis/{logging_kinesis_name}	Update the Amazon Kinesis log endpoint

create_log_kinesis

LoggingKinesisResponse create_log_kinesis(service_id, version_id)

Create an Amazon Kinesis log endpoint

Create an Amazon Kinesis Data Streams logging object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_kinesis_api
from fastly.model.aws_region import AwsRegion
from fastly.model.logging_placement import LoggingPlacement
from fastly.model.logging_kinesis_response import LoggingKinesisResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.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: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_kinesis_api.LoggingKinesisApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    name = "test-log-endpoint" # str | The name for the real-time logging configuration. (optional)
    placement = LoggingPlacement("none") # LoggingPlacement |  (optional)
    format = "{"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, \"true\", \"false\")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}" # str | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). (optional) if omitted the server will use the default value of "{"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, \"true\", \"false\")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}"
    topic = "topic_example" # str | The Amazon Kinesis stream to send logs to. Required. (optional)
    region = AwsRegion("us-east-1") # AwsRegion |  (optional)
    secret_key = "secret_key_example" # str, none_type | The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified. (optional)
    access_key = "access_key_example" # str, none_type | The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified. (optional)
    iam_role = "iam_role_example" # str, none_type | The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided. (optional)
    format_version = 2 # int | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.  (optional) if omitted the server will use the default value of 2

    # example passing only required values which don't have defaults set
    try:
        # Create  an Amazon Kinesis log endpoint
        api_response = api_instance.create_log_kinesis(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->create_log_kinesis: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create  an Amazon Kinesis log endpoint
        api_response = api_instance.create_log_kinesis(service_id, version_id, name=name, placement=placement, format=format, topic=topic, region=region, secret_key=secret_key, access_key=access_key, iam_role=iam_role, format_version=format_version)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->create_log_kinesis: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
name	str	The name for the real-time logging configuration.	[optional]
placement	LoggingPlacement		[optional]
format	str	A Fastly log format string.	[optional] if omitted the server will use the default value of "{"timestamp":"%{begin:%Y-%m-%dT%H:%M:%S}t","time_elapsed":"%{time.elapsed.usec}V","is_tls":"%{if(req.is_ssl, "true", "false")}V","client_ip":"%{req.http.Fastly-Client-IP}V","geo_city":"%{client.geo.city}V","geo_country_code":"%{client.geo.country_code}V","request":"%{req.request}V","host":"%{req.http.Fastly-Orig-Host}V","url":"%{json.escape(req.url)}V","request_referer":"%{json.escape(req.http.Referer)}V","request_user_agent":"%{json.escape(req.http.User-Agent)}V","request_accept_language":"%{json.escape(req.http.Accept-Language)}V","request_accept_charset":"%{json.escape(req.http.Accept-Charset)}V","cache_status":"%{regsub(fastly_info.state, "^(HIT-(SYNTH)
topic	str	The Amazon Kinesis stream to send logs to. Required.	[optional]
region	AwsRegion		[optional]
secret_key	str, none_type	The secret key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.	[optional]
access_key	str, none_type	The access key associated with the target Amazon Kinesis stream. Not required if `iam_role` is specified.	[optional]
iam_role	str, none_type	The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if `access_key` and `secret_key` are provided.	[optional]
format_version	int	The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.	[optional] if omitted the server will use the default value of 2

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

delete_log_kinesis

InlineResponse200 delete_log_kinesis(service_id, version_id, logging_kinesis_name)

Delete the Amazon Kinesis log endpoint

Delete an Amazon Kinesis Data Streams logging object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_kinesis_api
from fastly.model.inline_response200 import InlineResponse200
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.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: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_kinesis_api.LoggingKinesisApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_kinesis_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Delete the Amazon Kinesis log endpoint
        api_response = api_instance.delete_log_kinesis(service_id, version_id, logging_kinesis_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->delete_log_kinesis: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_kinesis_name	str	The name for the real-time logging configuration.

Return type

InlineResponse200

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

get_log_kinesis

LoggingKinesisResponse get_log_kinesis(service_id, version_id, logging_kinesis_name)

Get an Amazon Kinesis log endpoint

Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_kinesis_api
from fastly.model.logging_kinesis_response import LoggingKinesisResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.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: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_kinesis_api.LoggingKinesisApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_kinesis_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Get an Amazon Kinesis log endpoint
        api_response = api_instance.get_log_kinesis(service_id, version_id, logging_kinesis_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->get_log_kinesis: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_kinesis_name	str	The name for the real-time logging configuration.

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

list_log_kinesis

[LoggingKinesisResponse] list_log_kinesis(service_id, version_id)

List Amazon Kinesis log endpoints

List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_kinesis_api
from fastly.model.logging_kinesis_response import LoggingKinesisResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.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: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_kinesis_api.LoggingKinesisApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.

    # example passing only required values which don't have defaults set
    try:
        # List Amazon Kinesis log endpoints
        api_response = api_instance.list_log_kinesis(service_id, version_id)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->list_log_kinesis: %s\n" % e)

Parameters

Name	Type	Description	Notes
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.

Return type

[LoggingKinesisResponse]

Authorization

token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

update_log_kinesis

LoggingKinesisResponse update_log_kinesis(service_id, version_id, logging_kinesis_name)

Update the Amazon Kinesis log endpoint

Update an Amazon Kinesis Data Streams logging object for a particular service and version.

Example

Api Key Authentication (token):

import time
import fastly
from fastly.api import logging_kinesis_api
from fastly.model.logging_kinesis_response import LoggingKinesisResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.fastly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = fastly.Configuration(
    host = "https://api.fastly.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: token
configuration.api_key['token'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['token'] = 'Bearer'

# Enter a context with an instance of the API client
with fastly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = logging_kinesis_api.LoggingKinesisApi(api_client)
    service_id = "SU1Z0isxPaozGVKXdv0eY" # str | Alphanumeric string identifying the service.
    version_id = 1 # int | Integer identifying a service version.
    logging_kinesis_name = "test-log-endpoint" # str | The name for the real-time logging configuration.

    # example passing only required values which don't have defaults set
    try:
        # Update the Amazon Kinesis log endpoint
        api_response = api_instance.update_log_kinesis(service_id, version_id, logging_kinesis_name)
        pprint(api_response)
    except fastly.ApiException as e:
        print("Exception when calling LoggingKinesisApi->update_log_kinesis: %s\n" % e)

Parameters

Name	Type	Description
service_id	str	Alphanumeric string identifying the service.
version_id	int	Integer identifying a service version.
logging_kinesis_name	str	The name for the real-time logging configuration.

Return type

LoggingKinesisResponse

Authorization

token

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-

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

Files

LoggingKinesisApi.md

Latest commit

History

LoggingKinesisApi.md

File metadata and controls

fastly.LoggingKinesisApi

create_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_log_kinesis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details