execute_action ¶

def execute_action(
    self,
    target_resource: "capo_iotsitewise.types.target_resource.TargetResource",
    action_definition_id: "capo_iotsitewise.types.id.ID",
    action_payload: "capo_iotsitewise.types.action_payload.ActionPayload",
    *,
    config_overrides: Optional[IoTSiteWiseClientConfig] = None,
    client_token: Optional[
        "capo_iotsitewise.types.client_token.ClientToken"
    ] = None,
    resolve_to: Optional["capo_iotsitewise.types.resolve_to.ResolveTo"] = None,
) -> "capo_iotsitewise.types.execute_action_response.ExecuteActionResponse":
    """<p>Executes an action on a target resource.</p>

    Args:
        target_resource: <p>The resource the action will be taken on.</p>
        action_definition_id: <p>The ID of the action definition.</p>
        action_payload: <p>The JSON payload of the action.</p>
        client_token: <p>A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.</p>
        resolve_to: <p>The detailed resource this action resolves to.</p>

    Raises:
        capo_iotsitewise.errors.conflicting_operation_exception.ConflictingOperationException: <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotsitewise.errors.internal_failure_exception.InternalFailureException: <p>IoT SiteWise can't process your request right now. Try again later.</p>
        capo_iotsitewise.errors.invalid_request_exception.InvalidRequestException: <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
        capo_iotsitewise.errors.limit_exceeded_exception.LimitExceededException: <p>You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The requested resource can't be found.</p>
        capo_iotsitewise.errors.throttling_exception.ThrottlingException: <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
        capo_iotsitewise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iotsitewise.types.execute_action_request.ExecuteActionRequest]",
    ) -> OperationResponse[
        "capo_iotsitewise.types.execute_action_response.ExecuteActionResponse"
    ]:
        import capo_iotsitewise._operations.aws_io_t_site_wise.execute_action

        output, http_response = (
            capo_iotsitewise._operations.aws_io_t_site_wise.execute_action.execute_action(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ExecuteAction")
    )
    input_: capo_iotsitewise.types.execute_action_request.ExecuteActionRequest = {
        "target_resource": target_resource,
        "action_definition_id": action_definition_id,
        "action_payload": action_payload,
    }
    if client_token is not None:
        input_["client_token"] = client_token
    if resolve_to is not None:
        input_["resolve_to"] = resolve_to

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output