Class PolicyGeneration

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.PolicyGeneration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PolicyGeneration.Builder,PolicyGeneration>
@Generated("software.amazon.awssdk:codegen") public final class PolicyGeneration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PolicyGeneration.Builder,PolicyGeneration>

Represents a policy generation request within the AgentCore Policy system. Tracks the AI-powered conversion of natural language descriptions into Cedar policy statements, enabling users to author policies by describing authorization requirements in plain English. The generation process analyzes the natural language input along with the Gateway's tool context and Cedar schema to produce one or more validated policy options. Each generation request tracks the status of the conversion process and maintains findings about the generated policies, including validation results and potential issues. Generated policy assets remain available for one week after successful generation, allowing time to review and create policies from the generated options.

See Also:

  • Method Details

    • policyEngineId

      public final String policyEngineId()

      The identifier of the policy engine associated with this generation request.

      Returns:
      The identifier of the policy engine associated with this generation request.

    • policyGenerationId

      public final String policyGenerationId()

      The unique identifier for this policy generation request.

      Returns:
      The unique identifier for this policy generation request.

    • name

      public final String name()

      The customer-assigned name for this policy generation request.

      Returns:
      The customer-assigned name for this policy generation request.

    • policyGenerationArn

      public final String policyGenerationArn()

      The ARN of this policy generation request.

      Returns:
      The ARN of this policy generation request.

    • resource

      public final Resource resource()

      The resource information associated with this policy generation.

      Returns:
      The resource information associated with this policy generation.

    • createdAt

      public final Instant createdAt()

      The timestamp when this policy generation request was created.

      Returns:
      The timestamp when this policy generation request was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when this policy generation was last updated.

      Returns:
      The timestamp when this policy generation was last updated.

    • status

      public final PolicyGenerationStatus status()

      The current status of this policy generation request.

      If the service returns an enum value that is not available in the current SDK version, status will return PolicyGenerationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of this policy generation request.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of this policy generation request.

      If the service returns an enum value that is not available in the current SDK version, status will return PolicyGenerationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of this policy generation request.
      See Also:

    • hasStatusReasons

      public final boolean hasStatusReasons()
      For responses, this returns true if the service returned a value for the StatusReasons 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.

    • statusReasons

      public final List<String> statusReasons()

      Additional information about the generation status.

      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 hasStatusReasons() method.

      Returns:
      Additional information about the generation status.

    • findings

      public final String findings()

      Findings and insights from this policy generation process.

      Returns:
      Findings and insights from this policy generation process.

    • toBuilder

      public PolicyGeneration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PolicyGeneration.Builder,PolicyGeneration>
      Returns:
      a builder for type T

    • builder

      public static PolicyGeneration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PolicyGeneration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.