Class StartCalculationExecutionRequest

    • Method Detail

      • sessionId

        public final String sessionId()

        The session ID.

        Returns:
        The session ID.
      • description

        public final String description()

        A description of the calculation.

        Returns:
        A description of the calculation.
      • calculationConfiguration

        @Deprecated
        public final CalculationConfiguration calculationConfiguration()
        Deprecated.
        Kepler Post GA Tasks : https://sim.amazon.com/issues/ATHENA-39828

        Contains configuration information for the calculation.

        Returns:
        Contains configuration information for the calculation.
      • clientRequestToken

        public final String clientRequestToken()

        A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

        This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

        Returns:
        A unique case-sensitive string used to ensure the request to create the calculation is idempotent (executes only once). If another StartCalculationExecutionRequest is received, the same response is returned and another calculation is not created. If a parameter has changed, an error is returned.

        This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for users. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object