Package software.amazon.awssdk.services.s3control.model

Interface ListAccessGrantsRequest.Builder

    • Method Detail

      • accountId

        ListAccessGrantsRequest.Builder accountId​(String accountId)

        The ID of the Amazon Web Services account that is making this request.

        Parameters:
        accountId - The ID of the Amazon Web Services account that is making this request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListAccessGrantsRequest.Builder nextToken​(String nextToken)

        A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.

        Parameters:
        nextToken - A pagination token to request the next page of results. Pass this value into a subsequent List Access Grants request in order to retrieve the next page of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListAccessGrantsRequest.Builder maxResults​(Integer maxResults)

        The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.

        Parameters:
        maxResults - The maximum number of access grants that you would like returned in the List Access Grants response. If the results include the pagination token NextToken, make another call using the NextToken to determine if there are more results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • granteeType

        ListAccessGrantsRequest.Builder granteeType​(String granteeType)

        The type of the grantee to which access has been granted. It can be one of the following values:

        • IAM - An IAM user or role.

        • DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        • DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        Parameters:
        granteeType - The type of the grantee to which access has been granted. It can be one of the following values:

        • IAM - An IAM user or role.

        • DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        • DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GranteeType, GranteeType

      • granteeType

        ListAccessGrantsRequest.Builder granteeType​(GranteeType granteeType)

        The type of the grantee to which access has been granted. It can be one of the following values:

        • IAM - An IAM user or role.

        • DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        • DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        Parameters:
        granteeType - The type of the grantee to which access has been granted. It can be one of the following values:

        • IAM - An IAM user or role.

        • DIRECTORY_USER - Your corporate directory user. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        • DIRECTORY_GROUP - Your corporate directory group. You can use this option if you have added your corporate identity directory to IAM Identity Center and associated the IAM Identity Center instance with your S3 Access Grants instance.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GranteeType, GranteeType

      • granteeIdentifier

        ListAccessGrantsRequest.Builder granteeIdentifier​(String granteeIdentifier)

        The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.

        Parameters:
        granteeIdentifier - The unique identifer of the Grantee. If the grantee type is IAM, the identifier is the IAM Amazon Resource Name (ARN) of the user or role. If the grantee type is a directory user or group, the identifier is 128-bit universally unique identifier (UUID) in the format a1b2c3d4-5678-90ab-cdef-EXAMPLE11111. You can obtain this UUID from your Amazon Web Services IAM Identity Center instance.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • permission

        ListAccessGrantsRequest.Builder permission​(String permission)

        The type of permission granted to your S3 data, which can be set to 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.

        Parameters:
        permission - The type of permission granted to your S3 data, which can be set to 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Permission, Permission

      • permission

        ListAccessGrantsRequest.Builder permission​(Permission permission)

        The type of permission granted to your S3 data, which can be set to 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.

        Parameters:
        permission - The type of permission granted to your S3 data, which can be set to 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Permission, Permission

      • grantScope

        ListAccessGrantsRequest.Builder grantScope​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • applicationArn

        ListAccessGrantsRequest.Builder applicationArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.