CloudWatchService overview
Added in v1.0.0
Table of contents
constructors
makeCloudWatchService
Signature
export declare const makeCloudWatchService: Effect.Effect<any, unknown, unknown>
Added in v1.0.0
models
CloudWatchService (class)
Signature
export declare class CloudWatchService
Added in v1.0.0
CloudWatchService$ (interface)
Signature
export interface CloudWatchService$ {
/**
* @see {@link AssociateDatasetKmsKeyCommand}
*/
associateDatasetKmsKey(
args: AssociateDatasetKmsKeyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
AssociateDatasetKmsKeyCommandOutput,
| Cause.TimeoutError
| SdkError
| ConflictError
| KmsAccessDeniedError
| KmsKeyDisabledError
| KmsKeyNotFoundError
| ResourceNotFoundError
>
/**
* @see {@link CreateResourceMetricsConfigurationCommand}
*/
createResourceMetricsConfiguration(
args: CreateResourceMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
CreateResourceMetricsConfigurationCommandOutput,
Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError
>
/**
* @see {@link DeleteAlarmMuteRuleCommand}
*/
deleteAlarmMuteRule(
args: DeleteAlarmMuteRuleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DeleteAlarmMuteRuleCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link DeleteAlarmsCommand}
*/
deleteAlarms(
args: DeleteAlarmsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteAlarmsCommandOutput,
Cause.TimeoutError | SdkError | ResourceConflictError | ResourceNotFoundError
>
/**
* @see {@link DeleteAnomalyDetectorCommand}
*/
deleteAnomalyDetector(
args: DeleteAnomalyDetectorCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteAnomalyDetectorCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| MissingRequiredParameterError
| ResourceNotFoundExceptionError
>
/**
* @see {@link DeleteDashboardsCommand}
*/
deleteDashboards(
args: DeleteDashboardsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteDashboardsCommandOutput,
Cause.TimeoutError | SdkError | ConflictError | InternalServiceFaultError | InvalidParameterValueError
>
/**
* @see {@link DeleteInsightRulesCommand}
*/
deleteInsightRules(
args: DeleteInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | MissingRequiredParameterError
>
/**
* @see {@link DeleteMetricStreamCommand}
*/
deleteMetricStream(
args: DeleteMetricStreamCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteMetricStreamCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link DeleteResourceMetricsConfigurationCommand}
*/
deleteResourceMetricsConfiguration(
args: DeleteResourceMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DeleteResourceMetricsConfigurationCommandOutput,
Cause.TimeoutError | SdkError | ResourceNotFoundError
>
/**
* @see {@link DescribeAlarmContributorsCommand}
*/
describeAlarmContributors(
args: DescribeAlarmContributorsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeAlarmContributorsCommandOutput,
Cause.TimeoutError | SdkError | InvalidNextTokenError | ResourceNotFoundError
>
/**
* @see {@link DescribeAlarmHistoryCommand}
*/
describeAlarmHistory(
args: DescribeAlarmHistoryCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DescribeAlarmHistoryCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
describeAlarmHistoryStream(
args: DescribeAlarmHistoryCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<DescribeAlarmHistoryCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
/**
* @see {@link DescribeAlarmsCommand}
*/
describeAlarms(
args: DescribeAlarmsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DescribeAlarmsCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
describeAlarmsStream(
args: DescribeAlarmsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<DescribeAlarmsCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
/**
* @see {@link DescribeAlarmsForMetricCommand}
*/
describeAlarmsForMetric(
args: DescribeAlarmsForMetricCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DescribeAlarmsForMetricCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link DescribeAnomalyDetectorsCommand}
*/
describeAnomalyDetectors(
args: DescribeAnomalyDetectorsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DescribeAnomalyDetectorsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidNextTokenError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
describeAnomalyDetectorsStream(
args: DescribeAnomalyDetectorsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
DescribeAnomalyDetectorsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidNextTokenError
| InvalidParameterCombinationError
| InvalidParameterValueError
>
/**
* @see {@link DescribeInsightRulesCommand}
*/
describeInsightRules(
args: DescribeInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DescribeInsightRulesCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
describeInsightRulesStream(
args: DescribeInsightRulesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<DescribeInsightRulesCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
/**
* @see {@link DisableAlarmActionsCommand}
*/
disableAlarmActions(
args: DisableAlarmActionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<DisableAlarmActionsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link DisableInsightRulesCommand}
*/
disableInsightRules(
args: DisableInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DisableInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | MissingRequiredParameterError
>
/**
* @see {@link DisassociateDatasetKmsKeyCommand}
*/
disassociateDatasetKmsKey(
args: DisassociateDatasetKmsKeyCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
DisassociateDatasetKmsKeyCommandOutput,
Cause.TimeoutError | SdkError | ConflictError | ResourceNotFoundError
>
/**
* @see {@link EnableAlarmActionsCommand}
*/
enableAlarmActions(
args: EnableAlarmActionsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<EnableAlarmActionsCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link EnableInsightRulesCommand}
*/
enableInsightRules(
args: EnableInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
EnableInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | LimitExceededError | MissingRequiredParameterError
>
/**
* @see {@link GetAlarmMuteRuleCommand}
*/
getAlarmMuteRule(
args: GetAlarmMuteRuleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetAlarmMuteRuleCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>
/**
* @see {@link GetDashboardCommand}
*/
getDashboard(
args: GetDashboardCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetDashboardCommandOutput,
Cause.TimeoutError | SdkError | DashboardNotFoundError | InternalServiceFaultError | InvalidParameterValueError
>
/**
* @see {@link GetDatasetCommand}
*/
getDataset(
args: GetDatasetCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetDatasetCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>
/**
* @see {@link GetInsightRuleReportCommand}
*/
getInsightRuleReport(
args: GetInsightRuleReportCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetInsightRuleReportCommandOutput,
| Cause.TimeoutError
| SdkError
| InvalidParameterValueError
| MissingRequiredParameterError
| ResourceNotFoundExceptionError
>
/**
* @see {@link GetMetricDataCommand}
*/
getMetricData(
args: GetMetricDataCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetMetricDataCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
getMetricDataStream(
args: GetMetricDataCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<GetMetricDataCommandOutput, Cause.TimeoutError | SdkError | InvalidNextTokenError>
/**
* @see {@link GetMetricStatisticsCommand}
*/
getMetricStatistics(
args: GetMetricStatisticsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetMetricStatisticsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link GetMetricStreamCommand}
*/
getMetricStream(
args: GetMetricStreamCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
GetMetricStreamCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| MissingRequiredParameterError
| ResourceNotFoundExceptionError
>
/**
* @see {@link GetMetricWidgetImageCommand}
*/
getMetricWidgetImage(
args: GetMetricWidgetImageCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetMetricWidgetImageCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link GetOTelEnrichmentCommand}
*/
getOTelEnrichment(
args: GetOTelEnrichmentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetOTelEnrichmentCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link GetResourceMetricsConfigurationCommand}
*/
getResourceMetricsConfiguration(
args: GetResourceMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<GetResourceMetricsConfigurationCommandOutput, Cause.TimeoutError | SdkError | ResourceNotFoundError>
/**
* @see {@link ListAlarmMuteRulesCommand}
*/
listAlarmMuteRules(
args: ListAlarmMuteRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListAlarmMuteRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidNextTokenError | ResourceNotFoundError
>
listAlarmMuteRulesStream(
args: ListAlarmMuteRulesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListAlarmMuteRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidNextTokenError | ResourceNotFoundError
>
/**
* @see {@link ListDashboardsCommand}
*/
listDashboards(
args: ListDashboardsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListDashboardsCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceFaultError | InvalidParameterValueError
>
listDashboardsStream(
args: ListDashboardsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListDashboardsCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceFaultError | InvalidParameterValueError
>
/**
* @see {@link ListManagedInsightRulesCommand}
*/
listManagedInsightRules(
args: ListManagedInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListManagedInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidNextTokenError | InvalidParameterValueError | MissingRequiredParameterError
>
listManagedInsightRulesStream(
args: ListManagedInsightRulesCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListManagedInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidNextTokenError | InvalidParameterValueError | MissingRequiredParameterError
>
/**
* @see {@link ListMetricStreamsCommand}
*/
listMetricStreams(
args: ListMetricStreamsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListMetricStreamsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidNextTokenError
| InvalidParameterValueError
| MissingRequiredParameterError
>
listMetricStreamsStream(
args: ListMetricStreamsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListMetricStreamsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidNextTokenError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link ListMetricsCommand}
*/
listMetrics(
args: ListMetricsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListMetricsCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceFaultError | InvalidParameterValueError
>
listMetricsStream(
args: ListMetricsCommandInput,
options?: HttpHandlerOptions
): Stream.Stream<
ListMetricsCommandOutput,
Cause.TimeoutError | SdkError | InternalServiceFaultError | InvalidParameterValueError
>
/**
* @see {@link ListTagsForResourceCommand}
*/
listTagsForResource(
args: ListTagsForResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
ListTagsForResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterValueError
| ResourceNotFoundExceptionError
>
/**
* @see {@link PutAlarmMuteRuleCommand}
*/
putAlarmMuteRule(
args: PutAlarmMuteRuleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutAlarmMuteRuleCommandOutput, Cause.TimeoutError | SdkError | LimitExceededFaultError>
/**
* @see {@link PutAnomalyDetectorCommand}
*/
putAnomalyDetector(
args: PutAnomalyDetectorCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutAnomalyDetectorCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| LimitExceededError
| MissingRequiredParameterError
>
/**
* @see {@link PutCompositeAlarmCommand}
*/
putCompositeAlarm(
args: PutCompositeAlarmCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutCompositeAlarmCommandOutput, Cause.TimeoutError | SdkError | LimitExceededFaultError>
/**
* @see {@link PutDashboardCommand}
*/
putDashboard(
args: PutDashboardCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutDashboardCommandOutput,
Cause.TimeoutError | SdkError | ConflictError | DashboardInvalidInputError | InternalServiceFaultError
>
/**
* @see {@link PutInsightRuleCommand}
*/
putInsightRule(
args: PutInsightRuleCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutInsightRuleCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | LimitExceededError | MissingRequiredParameterError
>
/**
* @see {@link PutLogAlarmCommand}
*/
putLogAlarm(
args: PutLogAlarmCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutLogAlarmCommandOutput,
Cause.TimeoutError | SdkError | LimitExceededFaultError | ResourceConflictError
>
/**
* @see {@link PutManagedInsightRulesCommand}
*/
putManagedInsightRules(
args: PutManagedInsightRulesCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutManagedInsightRulesCommandOutput,
Cause.TimeoutError | SdkError | InvalidParameterValueError | MissingRequiredParameterError
>
/**
* @see {@link PutMetricAlarmCommand}
*/
putMetricAlarm(
args: PutMetricAlarmCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<PutMetricAlarmCommandOutput, Cause.TimeoutError | SdkError | LimitExceededFaultError>
/**
* @see {@link PutMetricDataCommand}
*/
putMetricData(
args: PutMetricDataCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutMetricDataCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link PutMetricStreamCommand}
*/
putMetricStream(
args: PutMetricStreamCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
PutMetricStreamCommandOutput,
| Cause.TimeoutError
| SdkError
| ConcurrentModificationError
| InternalServiceFaultError
| InvalidParameterCombinationError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link SetAlarmStateCommand}
*/
setAlarmState(
args: SetAlarmStateCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
SetAlarmStateCommandOutput,
Cause.TimeoutError | SdkError | InvalidFormatFaultError | ResourceNotFoundError
>
/**
* @see {@link StartMetricStreamsCommand}
*/
startMetricStreams(
args: StartMetricStreamsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
StartMetricStreamsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link StartOTelEnrichmentCommand}
*/
startOTelEnrichment(
args: StartOTelEnrichmentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<StartOTelEnrichmentCommandOutput, Cause.TimeoutError | SdkError | ValidationError>
/**
* @see {@link StopMetricStreamsCommand}
*/
stopMetricStreams(
args: StopMetricStreamsCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
StopMetricStreamsCommandOutput,
| Cause.TimeoutError
| SdkError
| InternalServiceFaultError
| InvalidParameterValueError
| MissingRequiredParameterError
>
/**
* @see {@link StopOTelEnrichmentCommand}
*/
stopOTelEnrichment(
args: StopOTelEnrichmentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<StopOTelEnrichmentCommandOutput, Cause.TimeoutError | SdkError>
/**
* @see {@link TagResourceCommand}
*/
tagResource(
args: TagResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
TagResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| ConcurrentModificationError
| ConflictError
| InternalServiceFaultError
| InvalidParameterValueError
| ResourceNotFoundExceptionError
>
/**
* @see {@link UntagResourceCommand}
*/
untagResource(
args: UntagResourceCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UntagResourceCommandOutput,
| Cause.TimeoutError
| SdkError
| ConcurrentModificationError
| ConflictError
| InternalServiceFaultError
| InvalidParameterValueError
| ResourceNotFoundExceptionError
>
/**
* @see {@link UpdateOTelEnrichmentCommand}
*/
updateOTelEnrichment(
args: UpdateOTelEnrichmentCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateOTelEnrichmentCommandOutput,
Cause.TimeoutError | SdkError | ResourceNotFoundError | ValidationError
>
/**
* @see {@link UpdateResourceMetricsConfigurationCommand}
*/
updateResourceMetricsConfiguration(
args: UpdateResourceMetricsConfigurationCommandInput,
options?: HttpHandlerOptions
): Effect.Effect<
UpdateResourceMetricsConfigurationCommandOutput,
Cause.TimeoutError | SdkError | ResourceNotFoundError
>
}
Added in v1.0.0
utils
CloudWatchService (namespace)
Added in v1.0.0
Config (interface)
Signature
export interface Config extends Omit<CloudWatchClientConfig, "logger"> {
readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}
Added in v1.0.0
Type (type alias)
Signature
export type Type = CloudWatchService$
Added in v1.0.0