Interface DescribeAlarmsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchRequest.Builder
,CopyableBuilder<DescribeAlarmsRequest.Builder,
,DescribeAlarmsRequest> SdkBuilder<DescribeAlarmsRequest.Builder,
,DescribeAlarmsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeAlarmsRequest
-
Method Summary
Modifier and TypeMethodDescriptionactionPrefix
(String actionPrefix) Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action.alarmNamePrefix
(String alarmNamePrefix) An alarm name prefix.alarmNames
(String... alarmNames) The names of the alarms to retrieve information about.alarmNames
(Collection<String> alarmNames) The names of the alarms to retrieve information about.alarmTypes
(Collection<AlarmType> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.alarmTypes
(AlarmType... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.alarmTypesWithStrings
(String... alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.alarmTypesWithStrings
(Collection<String> alarmTypes) Use this parameter to specify whether you want the operation to return metric alarms or composite alarms.childrenOfAlarmName
(String childrenOfAlarmName) If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify.maxRecords
(Integer maxRecords) The maximum number of alarm descriptions to retrieve.The token returned by a previous call to indicate that there is more data available.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.parentsOfAlarmName
(String parentsOfAlarmName) If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify.stateValue
(String stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.stateValue
(StateValue stateValue) Specify this parameter to receive information only about alarms that are currently in the state that you specify.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
alarmNames
The names of the alarms to retrieve information about.
- Parameters:
alarmNames
- The names of the alarms to retrieve information about.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmNames
The names of the alarms to retrieve information about.
- Parameters:
alarmNames
- The names of the alarms to retrieve information about.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmNamePrefix
An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.
If this parameter is specified, you cannot specify
AlarmNames
.- Parameters:
alarmNamePrefix
- An alarm name prefix. If you specify this parameter, you receive information about all alarms that have names that start with this prefix.If this parameter is specified, you cannot specify
AlarmNames
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypesWithStrings
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.
For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypesWithStrings
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.
For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypes
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.
For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
alarmTypes
Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.
For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Parameters:
alarmTypes
- Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account.For example, if you omit this parameter or specify
MetricAlarms
, the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account.If you specify
CompositeAlarms
, the operation returns only a list of composite alarms, and does not return any metric alarms.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
childrenOfAlarmName
If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in the
AlarmRule
field of the composite alarm that you specify inChildrenOfAlarmName
. Information about the composite alarm that you name inChildrenOfAlarmName
is not returned.If you specify
ChildrenOfAlarmName
, you cannot specify any other parameters in the request except forMaxRecords
andNextToken
. If you do so, you receive a validation error.Only the
Alarm Name
,ARN
,StateValue
(OK/ALARM/INSUFFICIENT_DATA), andStateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform anotherDescribeAlarms
operation and specify the parent alarm names in theAlarmNames
parameter.- Parameters:
childrenOfAlarmName
- If you use this parameter and specify the name of a composite alarm, the operation returns information about the "children" alarms of the alarm you specify. These are the metric alarms and composite alarms referenced in theAlarmRule
field of the composite alarm that you specify inChildrenOfAlarmName
. Information about the composite alarm that you name inChildrenOfAlarmName
is not returned.If you specify
ChildrenOfAlarmName
, you cannot specify any other parameters in the request except forMaxRecords
andNextToken
. If you do so, you receive a validation error.Only the
Alarm Name
,ARN
,StateValue
(OK/ALARM/INSUFFICIENT_DATA), andStateUpdatedTimestamp
information are returned by this operation when you use this parameter. To get complete information about these alarms, perform anotherDescribeAlarms
operation and specify the parent alarm names in theAlarmNames
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parentsOfAlarmName
If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that have
AlarmRule
parameters that reference the alarm named inParentsOfAlarmName
. Information about the alarm that you specify inParentsOfAlarmName
is not returned.If you specify
ParentsOfAlarmName
, you cannot specify any other parameters in the request except forMaxRecords
andNextToken
. If you do so, you receive a validation error.Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another
DescribeAlarms
operation and specify the parent alarm names in theAlarmNames
parameter.- Parameters:
parentsOfAlarmName
- If you use this parameter and specify the name of a metric or composite alarm, the operation returns information about the "parent" alarms of the alarm you specify. These are the composite alarms that haveAlarmRule
parameters that reference the alarm named inParentsOfAlarmName
. Information about the alarm that you specify inParentsOfAlarmName
is not returned.If you specify
ParentsOfAlarmName
, you cannot specify any other parameters in the request except forMaxRecords
andNextToken
. If you do so, you receive a validation error.Only the Alarm Name and ARN are returned by this operation when you use this parameter. To get complete information about these alarms, perform another
DescribeAlarms
operation and specify the parent alarm names in theAlarmNames
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateValue
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
- Parameters:
stateValue
- Specify this parameter to receive information only about alarms that are currently in the state that you specify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stateValue
Specify this parameter to receive information only about alarms that are currently in the state that you specify.
- Parameters:
stateValue
- Specify this parameter to receive information only about alarms that are currently in the state that you specify.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
actionPrefix
Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.
- Parameters:
actionPrefix
- Use this parameter to filter the results of the operation to only those alarms that use a certain alarm action. For example, you could specify the ARN of an SNS topic to find all alarms that send notifications to that topic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxRecords
The maximum number of alarm descriptions to retrieve.
- Parameters:
maxRecords
- The maximum number of alarm descriptions to retrieve.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token returned by a previous call to indicate that there is more data available.
- Parameters:
nextToken
- The token returned by a previous call to indicate that there is more data available.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeAlarmsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeAlarmsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-