Class: Aws::S3Control::Types::GetAccessGrantResult

Inherits:

Struct

• Object
• Struct
• Aws::S3Control::Types::GetAccessGrantResult

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3control/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_grant_arn ⇒ String

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

• #access_grant_id ⇒ String

  The ID of the access grant.

• #access_grants_location_configuration ⇒ Types::AccessGrantsLocationConfiguration

  The configuration options of the grant location.

• #access_grants_location_id ⇒ String

  The ID of the registered location to which you are granting access.

• #application_arn ⇒ String

  The Amazon Resource Name (ARN) of an Amazon Web Services IAM Identity Center application associated with your Identity Center instance.

• #created_at ⇒ Time

  The date and time when you created the access grant.

• #grant_scope ⇒ String

  The S3 path of the data to which you are granting access.

• #grantee ⇒ Types::Grantee

  The user, group, or role to which you are granting access.

• #permission ⇒ String

  The type of permission that was granted in the access grant.

Instance Attribute Details

#access_grant_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#access_grant_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#access_grants_location_configuration ⇒ Types::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:

• (Types::AccessGrantsLocationConfiguration)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#access_grants_location_id ⇒ String

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:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#application_arn ⇒ String

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:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The date and time when you created the access grant.

Returns:

• (Time)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#grant_scope ⇒ String

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:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#grantee ⇒ Types::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:

• (Types::Grantee)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#permission ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-s3control/types.rb', line 2277

class GetAccessGrantResult < Struct.new(
  :created_at,
  :access_grant_id,
  :access_grant_arn,
  :grantee,
  :permission,
  :access_grants_location_id,
  :access_grants_location_configuration,
  :grant_scope,
  :application_arn)
  SENSITIVE = []
  include Aws::Structure
end