scaleway.audit_trail.v1alpha1 package

Submodules

scaleway.audit_trail.v1alpha1.api module

class scaleway.audit_trail.v1alpha1.api.AuditTrailV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.

List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the organization_id and optionally, the project_id. :param region: Region to target. If none is passed will use default region from the config. :param project_id: (Optional) ID of the Project containing the Audit Trail events. :param organization_id: ID of the Organization containing the Audit Trail events. :param resource_type: (Optional) Type of the Scaleway resource. :param method_name: (Optional) Name of the method of the API call performed. :param status: (Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied. :param recorded_after: (Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default. :param recorded_before: (Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default. :param order_by: :param page_size: :param page_token: :param product_name: (Optional) Name of the Scaleway product in a hyphenated format. :param service_name: (Optional) Name of the service of the API call performed. :param resource_id: (Optional) ID of the Scaleway resource. :return: ListEventsResponse

Usage:

result = api.list_events()

list_products(*, region: str | None = None, organization_id: str | None = None) → ListProductsResponse

Retrieve the list of Scaleway resources for which you have Audit Trail events. :param region: Region to target. If none is passed will use default region from the config. :param organization_id: ID of the Organization containing the Audit Trail events. :return: ListProductsResponse

Usage:

result = api.list_products()

scaleway.audit_trail.v1alpha1.marshalling module

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_AccountOrganizationInfo(data: Any) → AccountOrganizationInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_AccountProjectInfo(data: Any) → AccountProjectInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_AccountUserInfo(data: Any) → AccountUserInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_AppleSiliconServerInfo(data: Any) → AppleSiliconServerInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_BaremetalServerInfo(data: Any) → BaremetalServerInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_BaremetalSettingInfo(data: Any) → BaremetalSettingInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_Event(data: Any) → Event

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_EventPrincipal(data: Any) → EventPrincipal

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_EventSystem(data: Any) → EventSystem

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_InstanceServerInfo(data: Any) → InstanceServerInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_IpamIpInfo(data: Any) → IpamIpInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_KeyManagerKeyInfo(data: Any) → KeyManagerKeyInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_KubernetesACLInfo(data: Any) → KubernetesACLInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_KubernetesClusterInfo(data: Any) → KubernetesClusterInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_KubernetesNodeInfo(data: Any) → KubernetesNodeInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_KubernetesPoolInfo(data: Any) → KubernetesPoolInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_ListEventsResponse(data: Any) → ListEventsResponse

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_ListProductsResponse(data: Any) → ListProductsResponse

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerAclInfo(data: Any) → LoadBalancerAclInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerBackendInfo(data: Any) → LoadBalancerBackendInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerCertificateInfo(data: Any) → LoadBalancerCertificateInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerFrontendInfo(data: Any) → LoadBalancerFrontendInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerIpInfo(data: Any) → LoadBalancerIpInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerLbInfo(data: Any) → LoadBalancerLbInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_LoadBalancerRouteInfo(data: Any) → LoadBalancerRouteInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_Product(data: Any) → Product

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_ProductService(data: Any) → ProductService

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_Resource(data: Any) → Resource

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_SecretManagerSecretInfo(data: Any) → SecretManagerSecretInfo

scaleway.audit_trail.v1alpha1.marshalling.unmarshal_SecretManagerSecretVersionInfo(data: Any) → SecretManagerSecretVersionInfo

scaleway.audit_trail.v1alpha1.types module

class scaleway.audit_trail.v1alpha1.types.AccountOrganizationInfo: Bases: object

class scaleway.audit_trail.v1alpha1.types.AccountProjectInfo(description: 'str')

Bases: object

description: str

class scaleway.audit_trail.v1alpha1.types.AccountUserInfo(email: 'str', phone_number: 'Optional[str]' = None)

Bases: object

email: str

phone_number: str | None = None

class scaleway.audit_trail.v1alpha1.types.AppleSiliconServerInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.types.BaremetalServerInfo(description: 'str', tags: 'List[str]')

Bases: object

description: str

tags: List[str]

class scaleway.audit_trail.v1alpha1.types.BaremetalSettingInfo(type_: 'str')

Bases: object

type_: str

class scaleway.audit_trail.v1alpha1.types.Event(id: 'str', locality: 'str', organization_id: 'str', source_ip: 'str', product_name: 'str', service_name: 'str', method_name: 'str', resources: 'List[Resource]', request_id: 'str', status_code: 'int', recorded_at: 'Optional[datetime]' = None, project_id: 'Optional[str]' = None, user_agent: 'Optional[str]' = None, request_body: 'Optional[Dict[str, Any]]' = <factory>, principal: 'Optional[EventPrincipal]' = None, system: 'Optional[EventSystem]' = None)

Bases: object

id: str: ID of the event.

locality: str: Locality of the resource attached to the event.

method_name: str: API method called to trigger the event.

organization_id: str: Organization ID containing the event.

principal: EventPrincipal | None = None

product_name: str: Product name of the resource attached to the event.

project_id: str | None = None: (Optional) Project of the resource attached to the event.

recorded_at: datetime | None = None: Timestamp of the event.

request_body: Dict[str, Any] | None: Request at the origin of the event.

request_id: str: Unique identifier of the request at the origin of the event.

resources: List[Resource]: Resources attached to the event.

service_name: str: API name called to trigger the event.

source_ip: str: IP address at the origin of the event.

status_code: int: HTTP status code resulting of the API call.

system: EventSystem | None = None

user_agent: str | None = None: User Agent at the origin of the event.

class scaleway.audit_trail.v1alpha1.types.EventPrincipal(id: 'str')

Bases: object

id: str

class scaleway.audit_trail.v1alpha1.types.EventSystem(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.types.InstanceServerInfo(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.types.IpamIpInfo(address: 'str')

Bases: object

address: str

class scaleway.audit_trail.v1alpha1.types.KeyManagerKeyInfo: Bases: object

class scaleway.audit_trail.v1alpha1.types.KubernetesACLInfo: Bases: object

class scaleway.audit_trail.v1alpha1.types.KubernetesClusterInfo: Bases: object

class scaleway.audit_trail.v1alpha1.types.KubernetesNodeInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.types.KubernetesPoolInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.types.ListEventsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, resource_type: 'Optional[ResourceType]' = <ResourceType.UNKNOWN_TYPE: 'unknown_type'>, method_name: 'Optional[str]' = None, status: 'Optional[int]' = 0, recorded_after: 'Optional[datetime]' = None, recorded_before: 'Optional[datetime]' = None, order_by: 'Optional[ListEventsRequestOrderBy]' = <ListEventsRequestOrderBy.RECORDED_AT_DESC: 'recorded_at_desc'>, page_size: 'Optional[int]' = 0, page_token: 'Optional[str]' = None, product_name: 'Optional[str]' = None, service_name: 'Optional[str]' = None, resource_id: 'Optional[str]' = None)

Bases: object

method_name: str | None = None: (Optional) Name of the method of the API call performed.

order_by: ListEventsRequestOrderBy | None = 'recorded_at_desc'

organization_id: str | None = None: ID of the Organization containing the Audit Trail events.

page_size: int | None = 0

page_token: str | None = None

product_name: str | None = None: (Optional) Name of the Scaleway product in a hyphenated format.

project_id: str | None = None: (Optional) ID of the Project containing the Audit Trail events.

recorded_after: datetime | None = None: (Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default.

recorded_before: datetime | None = None: (Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default.

region: str | None = None: Region to target. If none is passed will use default region from the config.

resource_id: str | None = None: (Optional) ID of the Scaleway resource.

resource_type: ResourceType | None = 'unknown_type': (Optional) Type of the Scaleway resource.

service_name: str | None = None: (Optional) Name of the service of the API call performed.

status: int | None = 0: (Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied.

class scaleway.audit_trail.v1alpha1.types.ListEventsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

RECORDED_AT_ASC = 'recorded_at_asc'

RECORDED_AT_DESC = 'recorded_at_desc'

class scaleway.audit_trail.v1alpha1.types.ListEventsResponse(events: 'List[Event]', next_page_token: 'Optional[str]' = None)

Bases: object

events: List[Event]: Single page of events matching the requested criteria.

next_page_token: str | None = None: Page token to use in following calls to keep listing.

class scaleway.audit_trail.v1alpha1.types.ListProductsRequest(region: 'Optional[ScwRegion]' = None, organization_id: 'Optional[str]' = None)

Bases: object

organization_id: str | None = None: ID of the Organization containing the Audit Trail events.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.audit_trail.v1alpha1.types.ListProductsResponse(products: 'List[Product]', total_count: 'int')

Bases: object

products: List[Product]: List of all products integrated with Audit Trail.

total_count: int: Number of integrated products.

class scaleway.audit_trail.v1alpha1.types.LoadBalancerAclInfo(frontend_id: 'str')

Bases: object

frontend_id: str

class scaleway.audit_trail.v1alpha1.types.LoadBalancerBackendInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.types.LoadBalancerCertificateInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.types.LoadBalancerFrontendInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.types.LoadBalancerIpInfo(ip_address: 'str', lb_id: 'Optional[str]' = None)

Bases: object

ip_address: str

lb_id: str | None = None

class scaleway.audit_trail.v1alpha1.types.LoadBalancerLbInfo(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.types.LoadBalancerRouteInfo(frontend_id: 'str', backend_id: 'str')

Bases: object

backend_id: str

frontend_id: str

class scaleway.audit_trail.v1alpha1.types.Product(title: 'str', name: 'str', services: 'List[ProductService]')

Bases: object

name: str: Product name.

services: List[ProductService]: Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail.

title: str: Product title.

class scaleway.audit_trail.v1alpha1.types.ProductService(name: 'str', methods: 'List[str]')

Bases: object

methods: List[str]

name: str

class scaleway.audit_trail.v1alpha1.types.Resource(id: 'str', type_: 'ResourceType', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, deleted_at: 'Optional[datetime]' = None, name: 'Optional[str]' = None, secm_secret_info: 'Optional[SecretManagerSecretInfo]' = None, secm_secret_version_info: 'Optional[SecretManagerSecretVersionInfo]' = None, kube_cluster_info: 'Optional[KubernetesClusterInfo]' = None, kube_pool_info: 'Optional[KubernetesPoolInfo]' = None, kube_node_info: 'Optional[KubernetesNodeInfo]' = None, kube_acl_info: 'Optional[KubernetesACLInfo]' = None, keym_key_info: 'Optional[KeyManagerKeyInfo]' = None, secret_manager_secret_info: 'Optional[SecretManagerSecretInfo]' = None, secret_manager_version_info: 'Optional[SecretManagerSecretVersionInfo]' = None, key_manager_key_info: 'Optional[KeyManagerKeyInfo]' = None, account_user_info: 'Optional[AccountUserInfo]' = None, account_organization_info: 'Optional[AccountOrganizationInfo]' = None, instance_server_info: 'Optional[InstanceServerInfo]' = None, apple_silicon_server_info: 'Optional[AppleSiliconServerInfo]' = None, account_project_info: 'Optional[AccountProjectInfo]' = None, baremetal_server_info: 'Optional[BaremetalServerInfo]' = None, baremetal_setting_info: 'Optional[BaremetalSettingInfo]' = None, ipam_ip_info: 'Optional[IpamIpInfo]' = None, load_balancer_lb_info: 'Optional[LoadBalancerLbInfo]' = None, load_balancer_ip_info: 'Optional[LoadBalancerIpInfo]' = None, load_balancer_frontend_info: 'Optional[LoadBalancerFrontendInfo]' = None, load_balancer_backend_info: 'Optional[LoadBalancerBackendInfo]' = None, load_balancer_route_info: 'Optional[LoadBalancerRouteInfo]' = None, load_balancer_acl_info: 'Optional[LoadBalancerAclInfo]' = None, load_balancer_certificate_info: 'Optional[LoadBalancerCertificateInfo]' = None)

Bases: object

account_organization_info: AccountOrganizationInfo | None = None

account_project_info: AccountProjectInfo | None = None

account_user_info: AccountUserInfo | None = None

apple_silicon_server_info: AppleSiliconServerInfo | None = None

baremetal_server_info: BaremetalServerInfo | None = None

baremetal_setting_info: BaremetalSettingInfo | None = None

created_at: datetime | None = None

deleted_at: datetime | None = None

id: str

instance_server_info: InstanceServerInfo | None = None

ipam_ip_info: IpamIpInfo | None = None

key_manager_key_info: KeyManagerKeyInfo | None = None

keym_key_info: KeyManagerKeyInfo | None = None

kube_acl_info: KubernetesACLInfo | None = None

kube_cluster_info: KubernetesClusterInfo | None = None

kube_node_info: KubernetesNodeInfo | None = None

kube_pool_info: KubernetesPoolInfo | None = None

load_balancer_acl_info: LoadBalancerAclInfo | None = None

load_balancer_backend_info: LoadBalancerBackendInfo | None = None

load_balancer_certificate_info: LoadBalancerCertificateInfo | None = None

load_balancer_frontend_info: LoadBalancerFrontendInfo | None = None

load_balancer_ip_info: LoadBalancerIpInfo | None = None

load_balancer_lb_info: LoadBalancerLbInfo | None = None

load_balancer_route_info: LoadBalancerRouteInfo | None = None

name: str | None = None

secm_secret_info: SecretManagerSecretInfo | None = None

secm_secret_version_info: SecretManagerSecretVersionInfo | None = None

secret_manager_secret_info: SecretManagerSecretInfo | None = None

secret_manager_version_info: SecretManagerSecretVersionInfo | None = None

type_: ResourceType

updated_at: datetime | None = None

class scaleway.audit_trail.v1alpha1.types.ResourceType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACCOUNT_ORGANIZATION = 'account_organization'

ACCOUNT_PROJECT = 'account_project'

ACCOUNT_USER = 'account_user'

APPLE_SILICON_SERVER = 'apple_silicon_server'

BAREMETAL_SERVER = 'baremetal_server'

BAREMETAL_SETTING = 'baremetal_setting'

IAM_API_KEY = 'iam_api_key'

IAM_APPLICATION = 'iam_application'

IAM_GROUP = 'iam_group'

IAM_POLICY = 'iam_policy'

IAM_RULE = 'iam_rule'

IAM_SSH_KEY = 'iam_ssh_key'

IAM_USER = 'iam_user'

INSTANCE_IMAGE = 'instance_image'

INSTANCE_PLACEMENT_GROUP = 'instance_placement_group'

INSTANCE_SECURITY_GROUP = 'instance_security_group'

INSTANCE_SERVER = 'instance_server'

INSTANCE_SNAPSHOT = 'instance_snapshot'

INSTANCE_VOLUME = 'instance_volume'

IPAM_IP = 'ipam_ip'

KEYM_KEY = 'keym_key'

KEY_MANAGER_KEY = 'key_manager_key'

KUBE_ACL = 'kube_acl'

KUBE_CLUSTER = 'kube_cluster'

KUBE_NODE = 'kube_node'

KUBE_POOL = 'kube_pool'

LOAD_BALANCER_ACL = 'load_balancer_acl'

LOAD_BALANCER_BACKEND = 'load_balancer_backend'

LOAD_BALANCER_CERTIFICATE = 'load_balancer_certificate'

LOAD_BALANCER_FRONTEND = 'load_balancer_frontend'

LOAD_BALANCER_IP = 'load_balancer_ip'

LOAD_BALANCER_LB = 'load_balancer_lb'

LOAD_BALANCER_ROUTE = 'load_balancer_route'

SBS_SNAPSHOT = 'sbs_snapshot'

SBS_VOLUME = 'sbs_volume'

SECM_SECRET = 'secm_secret'

SECM_SECRET_VERSION = 'secm_secret_version'

SECRET_MANAGER_SECRET = 'secret_manager_secret'

SECRET_MANAGER_VERSION = 'secret_manager_version'

SFS_FILESYSTEM = 'sfs_filesystem'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.audit_trail.v1alpha1.types.SecretManagerSecretInfo(path: 'str', key_id: 'Optional[str]' = None)

Bases: object

key_id: str | None = None

path: str

class scaleway.audit_trail.v1alpha1.types.SecretManagerSecretVersionInfo(revision: 'int')

Bases: object

revision: int

Module contents

class scaleway.audit_trail.v1alpha1.AccountOrganizationInfo: Bases: object

class scaleway.audit_trail.v1alpha1.AccountProjectInfo(description: 'str')

Bases: object

description: str

class scaleway.audit_trail.v1alpha1.AccountUserInfo(email: 'str', phone_number: 'Optional[str]' = None)

Bases: object

email: str

phone_number: str | None = None

class scaleway.audit_trail.v1alpha1.AppleSiliconServerInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.AuditTrailV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to ensure accountability and security by recording events and changes performed within your Scaleway Organization.

List events. Retrieve the list of Audit Trail events for a Scaleway Organization and/or Project. You must specify the organization_id and optionally, the project_id. :param region: Region to target. If none is passed will use default region from the config. :param project_id: (Optional) ID of the Project containing the Audit Trail events. :param organization_id: ID of the Organization containing the Audit Trail events. :param resource_type: (Optional) Type of the Scaleway resource. :param method_name: (Optional) Name of the method of the API call performed. :param status: (Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied. :param recorded_after: (Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default. :param recorded_before: (Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default. :param order_by: :param page_size: :param page_token: :param product_name: (Optional) Name of the Scaleway product in a hyphenated format. :param service_name: (Optional) Name of the service of the API call performed. :param resource_id: (Optional) ID of the Scaleway resource. :return: ListEventsResponse

Usage:

result = api.list_events()

list_products(*, region: str | None = None, organization_id: str | None = None) → ListProductsResponse

Retrieve the list of Scaleway resources for which you have Audit Trail events. :param region: Region to target. If none is passed will use default region from the config. :param organization_id: ID of the Organization containing the Audit Trail events. :return: ListProductsResponse

Usage:

result = api.list_products()

class scaleway.audit_trail.v1alpha1.BaremetalServerInfo(description: 'str', tags: 'List[str]')

Bases: object

description: str

tags: List[str]

class scaleway.audit_trail.v1alpha1.BaremetalSettingInfo(type_: 'str')

Bases: object

type_: str

class scaleway.audit_trail.v1alpha1.Event(id: 'str', locality: 'str', organization_id: 'str', source_ip: 'str', product_name: 'str', service_name: 'str', method_name: 'str', resources: 'List[Resource]', request_id: 'str', status_code: 'int', recorded_at: 'Optional[datetime]' = None, project_id: 'Optional[str]' = None, user_agent: 'Optional[str]' = None, request_body: 'Optional[Dict[str, Any]]' = <factory>, principal: 'Optional[EventPrincipal]' = None, system: 'Optional[EventSystem]' = None)

Bases: object

id: str: ID of the event.

locality: str: Locality of the resource attached to the event.

method_name: str: API method called to trigger the event.

organization_id: str: Organization ID containing the event.

principal: EventPrincipal | None = None

product_name: str: Product name of the resource attached to the event.

project_id: str | None = None: (Optional) Project of the resource attached to the event.

recorded_at: datetime | None = None: Timestamp of the event.

request_body: Dict[str, Any] | None: Request at the origin of the event.

request_id: str: Unique identifier of the request at the origin of the event.

resources: List[Resource]: Resources attached to the event.

service_name: str: API name called to trigger the event.

source_ip: str: IP address at the origin of the event.

status_code: int: HTTP status code resulting of the API call.

system: EventSystem | None = None

user_agent: str | None = None: User Agent at the origin of the event.

class scaleway.audit_trail.v1alpha1.EventPrincipal(id: 'str')

Bases: object

id: str

class scaleway.audit_trail.v1alpha1.EventSystem(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.InstanceServerInfo(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.IpamIpInfo(address: 'str')

Bases: object

address: str

class scaleway.audit_trail.v1alpha1.KeyManagerKeyInfo: Bases: object

class scaleway.audit_trail.v1alpha1.KubernetesACLInfo: Bases: object

class scaleway.audit_trail.v1alpha1.KubernetesClusterInfo: Bases: object

class scaleway.audit_trail.v1alpha1.KubernetesNodeInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.KubernetesPoolInfo(id: 'str', name: 'str')

Bases: object

id: str

name: str

class scaleway.audit_trail.v1alpha1.ListEventsRequest(region: 'Optional[ScwRegion]' = None, project_id: 'Optional[str]' = None, organization_id: 'Optional[str]' = None, resource_type: 'Optional[ResourceType]' = <ResourceType.UNKNOWN_TYPE: 'unknown_type'>, method_name: 'Optional[str]' = None, status: 'Optional[int]' = 0, recorded_after: 'Optional[datetime]' = None, recorded_before: 'Optional[datetime]' = None, order_by: 'Optional[ListEventsRequestOrderBy]' = <ListEventsRequestOrderBy.RECORDED_AT_DESC: 'recorded_at_desc'>, page_size: 'Optional[int]' = 0, page_token: 'Optional[str]' = None, product_name: 'Optional[str]' = None, service_name: 'Optional[str]' = None, resource_id: 'Optional[str]' = None)

Bases: object

method_name: str | None = None: (Optional) Name of the method of the API call performed.

order_by: ListEventsRequestOrderBy | None = 'recorded_at_desc'

organization_id: str | None = None: ID of the Organization containing the Audit Trail events.

page_size: int | None = 0

page_token: str | None = None

product_name: str | None = None: (Optional) Name of the Scaleway product in a hyphenated format.

project_id: str | None = None: (Optional) ID of the Project containing the Audit Trail events.

recorded_after: datetime | None = None: (Optional) The recorded_after parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns one hour ago by default.

recorded_before: datetime | None = None: (Optional) The recorded_before parameter defines the latest timestamp up to which Audit Trail events are retrieved. Returns now by default.

region: str | None = None: Region to target. If none is passed will use default region from the config.

resource_id: str | None = None: (Optional) ID of the Scaleway resource.

resource_type: ResourceType | None = 'unknown_type': (Optional) Type of the Scaleway resource.

service_name: str | None = None: (Optional) Name of the service of the API call performed.

status: int | None = 0: (Optional) HTTP status code of the request. Returns either 200 if the request was successful or 403 if the permission was denied.

class scaleway.audit_trail.v1alpha1.ListEventsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

RECORDED_AT_ASC = 'recorded_at_asc'

RECORDED_AT_DESC = 'recorded_at_desc'

class scaleway.audit_trail.v1alpha1.ListEventsResponse(events: 'List[Event]', next_page_token: 'Optional[str]' = None)

Bases: object

events: List[Event]: Single page of events matching the requested criteria.

next_page_token: str | None = None: Page token to use in following calls to keep listing.

class scaleway.audit_trail.v1alpha1.ListProductsRequest(region: 'Optional[ScwRegion]' = None, organization_id: 'Optional[str]' = None)

Bases: object

organization_id: str | None = None: ID of the Organization containing the Audit Trail events.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.audit_trail.v1alpha1.ListProductsResponse(products: 'List[Product]', total_count: 'int')

Bases: object

products: List[Product]: List of all products integrated with Audit Trail.

total_count: int: Number of integrated products.

class scaleway.audit_trail.v1alpha1.LoadBalancerAclInfo(frontend_id: 'str')

Bases: object

frontend_id: str

class scaleway.audit_trail.v1alpha1.LoadBalancerBackendInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.LoadBalancerCertificateInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.LoadBalancerFrontendInfo(lb_id: 'str', name: 'str')

Bases: object

lb_id: str

name: str

class scaleway.audit_trail.v1alpha1.LoadBalancerIpInfo(ip_address: 'str', lb_id: 'Optional[str]' = None)

Bases: object

ip_address: str

lb_id: str | None = None

class scaleway.audit_trail.v1alpha1.LoadBalancerLbInfo(name: 'str')

Bases: object

name: str

class scaleway.audit_trail.v1alpha1.LoadBalancerRouteInfo(frontend_id: 'str', backend_id: 'str')

Bases: object

backend_id: str

frontend_id: str

class scaleway.audit_trail.v1alpha1.Product(title: 'str', name: 'str', services: 'List[ProductService]')

Bases: object

name: str: Product name.

services: List[ProductService]: Specifies the API versions of the products integrated with Audit Trail. Each version defines the methods logged by Audit Trail.

title: str: Product title.

class scaleway.audit_trail.v1alpha1.ProductService(name: 'str', methods: 'List[str]')

Bases: object

methods: List[str]

name: str

class scaleway.audit_trail.v1alpha1.Resource(id: 'str', type_: 'ResourceType', created_at: 'Optional[datetime]' = None, updated_at: 'Optional[datetime]' = None, deleted_at: 'Optional[datetime]' = None, name: 'Optional[str]' = None, secm_secret_info: 'Optional[SecretManagerSecretInfo]' = None, secm_secret_version_info: 'Optional[SecretManagerSecretVersionInfo]' = None, kube_cluster_info: 'Optional[KubernetesClusterInfo]' = None, kube_pool_info: 'Optional[KubernetesPoolInfo]' = None, kube_node_info: 'Optional[KubernetesNodeInfo]' = None, kube_acl_info: 'Optional[KubernetesACLInfo]' = None, keym_key_info: 'Optional[KeyManagerKeyInfo]' = None, secret_manager_secret_info: 'Optional[SecretManagerSecretInfo]' = None, secret_manager_version_info: 'Optional[SecretManagerSecretVersionInfo]' = None, key_manager_key_info: 'Optional[KeyManagerKeyInfo]' = None, account_user_info: 'Optional[AccountUserInfo]' = None, account_organization_info: 'Optional[AccountOrganizationInfo]' = None, instance_server_info: 'Optional[InstanceServerInfo]' = None, apple_silicon_server_info: 'Optional[AppleSiliconServerInfo]' = None, account_project_info: 'Optional[AccountProjectInfo]' = None, baremetal_server_info: 'Optional[BaremetalServerInfo]' = None, baremetal_setting_info: 'Optional[BaremetalSettingInfo]' = None, ipam_ip_info: 'Optional[IpamIpInfo]' = None, load_balancer_lb_info: 'Optional[LoadBalancerLbInfo]' = None, load_balancer_ip_info: 'Optional[LoadBalancerIpInfo]' = None, load_balancer_frontend_info: 'Optional[LoadBalancerFrontendInfo]' = None, load_balancer_backend_info: 'Optional[LoadBalancerBackendInfo]' = None, load_balancer_route_info: 'Optional[LoadBalancerRouteInfo]' = None, load_balancer_acl_info: 'Optional[LoadBalancerAclInfo]' = None, load_balancer_certificate_info: 'Optional[LoadBalancerCertificateInfo]' = None)

Bases: object

account_organization_info: AccountOrganizationInfo | None = None

account_project_info: AccountProjectInfo | None = None

account_user_info: AccountUserInfo | None = None

apple_silicon_server_info: AppleSiliconServerInfo | None = None

baremetal_server_info: BaremetalServerInfo | None = None

baremetal_setting_info: BaremetalSettingInfo | None = None

created_at: datetime | None = None

deleted_at: datetime | None = None

id: str

instance_server_info: InstanceServerInfo | None = None

ipam_ip_info: IpamIpInfo | None = None

key_manager_key_info: KeyManagerKeyInfo | None = None

keym_key_info: KeyManagerKeyInfo | None = None

kube_acl_info: KubernetesACLInfo | None = None

kube_cluster_info: KubernetesClusterInfo | None = None

kube_node_info: KubernetesNodeInfo | None = None

kube_pool_info: KubernetesPoolInfo | None = None

load_balancer_acl_info: LoadBalancerAclInfo | None = None

load_balancer_backend_info: LoadBalancerBackendInfo | None = None

load_balancer_certificate_info: LoadBalancerCertificateInfo | None = None

load_balancer_frontend_info: LoadBalancerFrontendInfo | None = None

load_balancer_ip_info: LoadBalancerIpInfo | None = None

load_balancer_lb_info: LoadBalancerLbInfo | None = None

load_balancer_route_info: LoadBalancerRouteInfo | None = None

name: str | None = None

secm_secret_info: SecretManagerSecretInfo | None = None

secm_secret_version_info: SecretManagerSecretVersionInfo | None = None

secret_manager_secret_info: SecretManagerSecretInfo | None = None

secret_manager_version_info: SecretManagerSecretVersionInfo | None = None

type_: ResourceType

updated_at: datetime | None = None

class scaleway.audit_trail.v1alpha1.ResourceType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

ACCOUNT_ORGANIZATION = 'account_organization'

ACCOUNT_PROJECT = 'account_project'

ACCOUNT_USER = 'account_user'

APPLE_SILICON_SERVER = 'apple_silicon_server'

BAREMETAL_SERVER = 'baremetal_server'

BAREMETAL_SETTING = 'baremetal_setting'

IAM_API_KEY = 'iam_api_key'

IAM_APPLICATION = 'iam_application'

IAM_GROUP = 'iam_group'

IAM_POLICY = 'iam_policy'

IAM_RULE = 'iam_rule'

IAM_SSH_KEY = 'iam_ssh_key'

IAM_USER = 'iam_user'

INSTANCE_IMAGE = 'instance_image'

INSTANCE_PLACEMENT_GROUP = 'instance_placement_group'

INSTANCE_SECURITY_GROUP = 'instance_security_group'

INSTANCE_SERVER = 'instance_server'

INSTANCE_SNAPSHOT = 'instance_snapshot'

INSTANCE_VOLUME = 'instance_volume'

IPAM_IP = 'ipam_ip'

KEYM_KEY = 'keym_key'

KEY_MANAGER_KEY = 'key_manager_key'

KUBE_ACL = 'kube_acl'

KUBE_CLUSTER = 'kube_cluster'

KUBE_NODE = 'kube_node'

KUBE_POOL = 'kube_pool'

LOAD_BALANCER_ACL = 'load_balancer_acl'

LOAD_BALANCER_BACKEND = 'load_balancer_backend'

LOAD_BALANCER_CERTIFICATE = 'load_balancer_certificate'

LOAD_BALANCER_FRONTEND = 'load_balancer_frontend'

LOAD_BALANCER_IP = 'load_balancer_ip'

LOAD_BALANCER_LB = 'load_balancer_lb'

LOAD_BALANCER_ROUTE = 'load_balancer_route'

SBS_SNAPSHOT = 'sbs_snapshot'

SBS_VOLUME = 'sbs_volume'

SECM_SECRET = 'secm_secret'

SECM_SECRET_VERSION = 'secm_secret_version'

SECRET_MANAGER_SECRET = 'secret_manager_secret'

SECRET_MANAGER_VERSION = 'secret_manager_version'

SFS_FILESYSTEM = 'sfs_filesystem'

UNKNOWN_TYPE = 'unknown_type'

class scaleway.audit_trail.v1alpha1.SecretManagerSecretInfo(path: 'str', key_id: 'Optional[str]' = None)

Bases: object

key_id: str | None = None

path: str

class scaleway.audit_trail.v1alpha1.SecretManagerSecretVersionInfo(revision: 'int')

Bases: object

revision: int