Class LogDeliveryClient

Index

Constructors

Methods

createLogDeliveryConfiguration getLogDeliveryConfiguration listLogDeliveryConfiguration listLogDeliveryConfigurationIter updateLogDeliveryConfiguration

Constructors

constructor

new LogDeliveryClient(options: ClientOptions): LogDeliveryClient
Parameters
- options: ClientOptions
Returns LogDeliveryClient
- Defined in client.ts:57

Methods

createLogDeliveryConfiguration

createLogDeliveryConfiguration(
req: CreateLogDeliveryConfigurationRequest,
options?: CallOptions,
): Promise<CreateLogDeliveryConfigurationResponse>
Creates a new log delivery configuration to enable delivery of the specified type of logs to your storage location. This requires that you already created a credential object (which encapsulates a cross-account service IAM role) and a storage configuration object (which encapsulates an S3 bucket).

For full details, including the required IAM role policies and bucket policies, see Deliver and access billable usage logs or Configure audit logging.

Note: There is a limit on the number of log delivery configurations available per account (each limit applies separately to each log type including billable usage and audit logs). You can create a maximum of two enabled account-level delivery configurations (configurations without a workspace filter) per type. Additionally, you can create two enabled workspace-level delivery configurations per workspace for each log type, which means that the same workspace ID can occur in the workspace filter for no more than two delivery configurations per log type.

You cannot delete a log delivery configuration, but you can disable it (see Enable or disable log delivery configuration).
Parameters
- req: CreateLogDeliveryConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<CreateLogDeliveryConfigurationResponse>
- Defined in client.ts:87

getLogDeliveryConfiguration

getLogDeliveryConfiguration(
req: GetLogDeliveryConfigurationRequest,
options?: CallOptions,
): Promise<GetLogDeliveryConfigurationResponse>
Gets a log delivery configuration object for an account, both specified by ID.
Parameters
- req: GetLogDeliveryConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<GetLogDeliveryConfigurationResponse>
- Defined in client.ts:120

listLogDeliveryConfiguration

listLogDeliveryConfiguration(
req: ListLogDeliveryConfigurationRequest,
options?: CallOptions,
): Promise<ListLogDeliveryConfigurationResponse>
Gets all log delivery configurations associated with an account specified by ID.
Parameters
- req: ListLogDeliveryConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<ListLogDeliveryConfigurationResponse>
- Defined in client.ts:149

listLogDeliveryConfigurationIter

listLogDeliveryConfigurationIter(
req: ListLogDeliveryConfigurationRequest,
options?: CallOptions,
): AsyncGenerator<LogDeliveryConfiguration>
Parameters
- req: ListLogDeliveryConfigurationRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<LogDeliveryConfiguration>
- Defined in client.ts:192

updateLogDeliveryConfiguration

updateLogDeliveryConfiguration(
req: UpdateLogDeliveryConfigurationRequest,
options?: CallOptions,
): Promise<UpdateLogDeliveryConfigurationResponse>
Enables or disables a log delivery configuration. Deletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed. Note that you can't re-enable a delivery configuration if this would violate the delivery configuration limits described under Create log delivery.
Parameters
- req: UpdateLogDeliveryConfigurationRequest
- Optionaloptions: CallOptions
Returns Promise<UpdateLogDeliveryConfigurationResponse>
- Defined in client.ts:214