Class CreateServiceActionRequest

    • Method Detail

      • name

        public final String name()

        The self-service action name.

        Returns:
        The self-service action name.
      • definition

        public final Map<ServiceActionDefinitionKey,​String> definition()

        The self-service action definition. Can be one of the following:

        Name

        The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

        If you are using a shared SSM document, you must provide the ARN instead of the name.

        Version

        The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

        AssumeRole

        The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

        To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

        Parameters

        The list of parameters in JSON format.

        For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDefinition() method.

        Returns:
        The self-service action definition. Can be one of the following:

        Name

        The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

        If you are using a shared SSM document, you must provide the ARN instead of the name.

        Version

        The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

        AssumeRole

        The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

        To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

        Parameters

        The list of parameters in JSON format.

        For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

      • hasDefinition

        public final boolean hasDefinition()
        For responses, this returns true if the service returned a value for the Definition property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • definitionAsStrings

        public final Map<String,​String> definitionAsStrings()

        The self-service action definition. Can be one of the following:

        Name

        The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

        If you are using a shared SSM document, you must provide the ARN instead of the name.

        Version

        The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

        AssumeRole

        The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

        To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

        Parameters

        The list of parameters in JSON format.

        For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDefinition() method.

        Returns:
        The self-service action definition. Can be one of the following:

        Name

        The name of the Amazon Web Services Systems Manager document (SSM document). For example, AWS-RestartEC2Instance.

        If you are using a shared SSM document, you must provide the ARN instead of the name.

        Version

        The Amazon Web Services Systems Manager automation document version. For example, "Version": "1"

        AssumeRole

        The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, "AssumeRole": "arn:aws:iam::12345678910:role/ActionRole".

        To reuse the provisioned product launch role, set to "AssumeRole": "LAUNCH_ROLE".

        Parameters

        The list of parameters in JSON format.

        For example: [{\"Name\":\"InstanceId\",\"Type\":\"TARGET\"}] or [{\"Name\":\"InstanceId\",\"Type\":\"TEXT_VALUE\"}].

      • description

        public final String description()

        The self-service action description.

        Returns:
        The self-service action description.
      • acceptLanguage

        public final String acceptLanguage()

        The language code.

        • jp - Japanese

        • zh - Chinese

        Returns:
        The language code.

        • jp - Japanese

        • zh - Chinese

      • idempotencyToken

        public final String idempotencyToken()

        A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

        Returns:
        A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.
      • 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