aws:waitForAwsResourceProperty
– Wait on an AWS resource
property
The aws:waitForAwsResourceProperty
action allows your automation to wait
for a specific resource state or event state before continuing the automation. For more
examples of how to use this action, see Additional runbook
examples.
Note
The default timeout value for this action is 3600 seconds (one hour). You can
limit or extend the timeout by specifying the timeoutSeconds
parameter
for an aws:waitForAwsResourceProperty
step. For more information and
examples of how to use this action, see Handling timeouts in runbooks.
Input
Inputs are defined by the API operation that you choose.
- Service
-
The AWS service namespace that contains the API operation that you want to run. For example, the namespace for AWS Systems Manager is
ssm
. The namespace for Amazon Elastic Compute Cloud (Amazon EC2) isec2
. You can view a list of supported AWS service namespaces in the Available Services section of the AWS CLI Command Reference.Type: String
Required: Yes
- Api
-
The name of the API operation that you want to run. You can view the API operations (also called methods) by choosing a service in the left navigation on the following Services Reference
page. Choose a method in the Client section for the service that you want to invoke. For example, all API operations (methods) for Amazon Relational Database Service (Amazon RDS) are listed on the following page: Amazon RDS methods . Type: String
Required: Yes
- API operation inputs
-
One or more API operation inputs. You can view the available inputs (also called parameters) by choosing a service in the left navigation on the following Services Reference
page. Choose a method in the Client section for the service that you want to invoke. For example, all methods for Amazon RDS are listed on the following page: Amazon RDS methods . Choose the describe_db_instances method and scroll down to see the available parameters, such as DBInstanceIdentifier, Name, and Values. Type: Determined by chosen API operation
Required: Yes
- PropertySelector
-
The JSONPath to a specific attribute in the response object. You can view the response objects by choosing a service in the left navigation on the following Services Reference
page. Choose a method in the Client section for the service that you want to invoke. For example, all methods for Amazon RDS are listed on the following page: Amazon RDS methods . Choose the describe_db_instances method and scroll down to the Response Structure section. DBInstances is listed as a response object. Type: String
Required: Yes
- DesiredValues
-
The expected status or state on which to continue the automation.
Type: MapList, StringList
Required: Yes