Class GetAccessGrantResponse

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

  • Method Details

    • createdAt

      public final Instant createdAt()

      The date and time when you created the access grant.

      Returns:
      The date and time when you created the access grant.

    • accessGrantId

      public final String accessGrantId()

      The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

      Returns:
      The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.

    • accessGrantArn

      public final String accessGrantArn()

      The Amazon Resource Name (ARN) of the access grant.

      Returns:
      The Amazon Resource Name (ARN) of the access grant.

    • grantee

      public final Grantee grantee()

      The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.

      Returns:
      The user, group, or role to which you are granting access. You can grant access to an IAM user or role. If you have added a corporate directory to Amazon Web Services IAM Identity Center and associated this Identity Center instance with the S3 Access Grants instance, the grantee can also be a corporate directory user or group.

    • permission

      public final Permission permission()

      The type of permission that was granted in the access grant. Can be one of the following values:

      • READ – Grant read-only access to the S3 data.

      • WRITE – Grant write-only access to the S3 data.

      • READWRITE – Grant both read and write access to the S3 data.

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

      Returns:
      The type of permission that was granted in the access grant. Can be one of the following values:

      • READ – Grant read-only access to the S3 data.

      • WRITE – Grant write-only access to the S3 data.

      • READWRITE – Grant both read and write access to the S3 data.

      See Also:

    • permissionAsString

      public final String permissionAsString()

      The type of permission that was granted in the access grant. Can be one of the following values:

      • READ – Grant read-only access to the S3 data.

      • WRITE – Grant write-only access to the S3 data.

      • READWRITE – Grant both read and write access to the S3 data.

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

      Returns:
      The type of permission that was granted in the access grant. Can be one of the following values:

      • READ – Grant read-only access to the S3 data.

      • WRITE – Grant write-only access to the S3 data.

      • READWRITE – Grant both read and write access to the S3 data.

      See Also:

    • accessGrantsLocationId

      public final String accessGrantsLocationId()

      The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

      Returns:
      The ID of the registered location to which you are granting access. S3 Access Grants assigns this ID when you register the location. S3 Access Grants assigns the ID default to the default location s3:// and assigns an auto-generated ID to other locations that you register.

    • accessGrantsLocationConfiguration

      public final AccessGrantsLocationConfiguration accessGrantsLocationConfiguration()

      The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

      Returns:
      The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access.

    • grantScope

      public final String grantScope()

      The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

      Returns:
      The S3 path of the data to which you are granting access. It is the result of appending the Subprefix to the location scope.

    • applicationArn

      public final String applicationArn()

      The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

      Returns:
      The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance. If the grant includes an application ARN, the grantee can only access the S3 data through this application.

    • toBuilder

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

    • builder

      public static GetAccessGrantResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetAccessGrantResponse.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.