Class GetPolicyResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.GetPolicyResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPolicyResponse.Builder,GetPolicyResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPolicyResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetPolicyResponse.Builder,GetPolicyResponse>

  • Method Details

    • policyId

      public final String policyId()

      The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

      Returns:
      The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

    • name

      public final String name()

      The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

      Returns:
      The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

    • policyEngineId

      public final String policyEngineId()

      The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

      Returns:
      The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

    • definition

      public final PolicyDefinition definition()

      The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

      Returns:
      The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

    • description

      public final String description()

      The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

      Returns:
      The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

    • createdAt

      public final Instant createdAt()

      The timestamp when the policy was originally created.

      Returns:
      The timestamp when the policy was originally created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

      Returns:
      The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

    • policyArn

      public final String policyArn()

      The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

      Returns:
      The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

    • status

      public final PolicyStatus status()

      The current status of the policy.

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

      Returns:
      The current status of the policy.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the policy.

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

      Returns:
      The current status of the policy.
      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 policy status. This provides details about any failures or the current state of the policy.

      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 policy status. This provides details about any failures or the current state of the policy.

    • toBuilder

      public GetPolicyResponse.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<GetPolicyResponse.Builder,GetPolicyResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPolicyResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.