Class GetAccessGrantResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetAccessGrantResponse.Builder,
GetAccessGrantResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Resource Name (ARN) of the access grant.final String
The ID of the access grant.The configuration options of the grant location.final String
The ID of the registered location to which you are granting access.final String
The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.builder()
final Instant
The date and time when you created the access grant.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final Grantee
grantee()
The user, group, or role to which you are granting access.final String
The S3 path of the data to which you are granting access.final int
hashCode()
final Permission
The type of permission that was granted in the access grant.final String
The type of permission that was granted in the access grant.static Class
<? extends GetAccessGrantResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.s3control.model.S3ControlResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
The date and time when you created the access grant.
- Returns:
- The date and time when you created the access grant.
-
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
The Amazon Resource Name (ARN) of the access grant.
- Returns:
- The Amazon Resource Name (ARN) of the access grant.
-
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
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 returnPermission.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionAsString()
.- 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
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 returnPermission.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompermissionAsString()
.- 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
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 locations3://
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 locations3://
and assigns an auto-generated ID to other locations that you register.
-
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
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
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
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 interfaceToCopyableBuilder<GetAccessGrantResponse.Builder,
GetAccessGrantResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-