Class AuditEventExportService

constructor

• new AuditEventExportService(sdk: SDKInterface): AuditEventExportService

  Parameters

  • sdk: SDKInterface

  Returns AuditEventExportService

$type

cancel

• cancel(
      request: CancelRequest,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Stop active audit events export to s3 bucket, all data written before calling this API remains in the bucket.

  Parameters

  • request: CancelRequest

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelRequest,
      metadata: Metadata,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CancelRequest
  • metadata: Metadata

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Parameters

  • request: CancelRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelRequest,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Stop active audit events export to s3 bucket, all data written before calling this API remains in the bucket.

  Parameters

  • request: CancelRequest

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelRequest,
      metadata: Metadata,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Stop active audit events export to s3 bucket, all data written before calling this API remains in the bucket.

  Parameters

  • request: CancelRequest
  • metadata: Metadata

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

• cancel(
      request: CancelRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CancelRequest, Operation<GetOperationRequest>>

  Stop active audit events export to s3 bucket, all data written before calling this API remains in the bucket.

  Parameters

  • request: CancelRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CancelRequest, Operation<GetOperationRequest>>

get

• get(request: GetRequest): Request<GetRequest, AuditEventExport>

  Returns the audit event export with the current progress status and the parameters with which it was created.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, AuditEventExport>

• get(
      request: GetRequest,
      metadata: Metadata,
  ): Request<GetRequest, AuditEventExport>

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, AuditEventExport>

• get(
      request: GetRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRequest, AuditEventExport>

  Parameters

  • request: GetRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRequest, AuditEventExport>

• get(request: GetRequest): Request<GetRequest, AuditEventExport>

  Returns the audit event export with the current progress status and the parameters with which it was created.

  Parameters

  • request: GetRequest

  Returns Request<GetRequest, AuditEventExport>

• get(
      request: GetRequest,
      metadata: Metadata,
  ): Request<GetRequest, AuditEventExport>

  Returns the audit event export with the current progress status and the parameters with which it was created.

  Parameters

  • request: GetRequest
  • metadata: Metadata

  Returns Request<GetRequest, AuditEventExport>

• get(
      request: GetRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetRequest, AuditEventExport>

  Returns the audit event export with the current progress status and the parameters with which it was created.

  Parameters

  • request: GetRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetRequest, AuditEventExport>

getOperationService

• getOperationService(): OperationService

  Returns OperationService

list

• list(request: ListRequest): Request<ListRequest, ListAuditEventExportResponse>

  Returns a list of exports created for a specific parent_id.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListAuditEventExportResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
  ): Request<ListRequest, ListAuditEventExportResponse>

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListAuditEventExportResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRequest, ListAuditEventExportResponse>

  Parameters

  • request: ListRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRequest, ListAuditEventExportResponse>

• list(request: ListRequest): Request<ListRequest, ListAuditEventExportResponse>

  Returns a list of exports created for a specific parent_id.

  Parameters

  • request: ListRequest

  Returns Request<ListRequest, ListAuditEventExportResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
  ): Request<ListRequest, ListAuditEventExportResponse>

  Returns a list of exports created for a specific parent_id.

  Parameters

  • request: ListRequest
  • metadata: Metadata

  Returns Request<ListRequest, ListAuditEventExportResponse>

• list(
      request: ListRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListRequest, ListAuditEventExportResponse>

  Returns a list of exports created for a specific parent_id.

  Parameters

  • request: ListRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListRequest, ListAuditEventExportResponse>

start

• start(
      request: StartRequest,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Start audit events export to s3 bucket for specific period.

  Parameters

  • request: StartRequest

  Returns Request<StartRequest, Operation<GetOperationRequest>>

• start(
      request: StartRequest,
      metadata: Metadata,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StartRequest
  • metadata: Metadata

  Returns Request<StartRequest, Operation<GetOperationRequest>>

• start(
      request: StartRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Parameters

  • request: StartRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StartRequest, Operation<GetOperationRequest>>

• start(
      request: StartRequest,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Start audit events export to s3 bucket for specific period.

  Parameters

  • request: StartRequest

  Returns Request<StartRequest, Operation<GetOperationRequest>>

• start(
      request: StartRequest,
      metadata: Metadata,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Start audit events export to s3 bucket for specific period.

  Parameters

  • request: StartRequest
  • metadata: Metadata

  Returns Request<StartRequest, Operation<GetOperationRequest>>

• start(
      request: StartRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<StartRequest, Operation<GetOperationRequest>>

  Start audit events export to s3 bucket for specific period.

  Parameters

  • request: StartRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<StartRequest, Operation<GetOperationRequest>>