Skip to content

GetAccessGrantResult

Source code in docs_src/capo_s3_control/types/get_access_grant_result.py
class GetAccessGrantResult(TypedDict, closed=True):
    created_at: NotRequired[
        "capo_s3_control.types.creation_timestamp.CreationTimestamp"
    ]
    """<p>The date and time when you created the access grant. </p>"""
    access_grant_id: NotRequired["capo_s3_control.types.access_grant_id.AccessGrantId"]
    """<p>The ID of the access grant. S3 Access Grants auto-generates this ID when you create the access grant.</p>"""
    access_grant_arn: NotRequired[
        "capo_s3_control.types.access_grant_arn.AccessGrantArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the access grant. </p>"""
    grantee: NotRequired["capo_s3_control.types.grantee.Grantee"]
    """<p>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.</p>"""
    permission: NotRequired["capo_s3_control.types.permission.Permission"]
    """<p>The type of permission that was granted in the access grant. Can be one of the following values:</p> <ul> <li> <p> <code>READ</code> – Grant read-only access to the S3 data.</p> </li> <li> <p> <code>WRITE</code> – Grant write-only access to the S3 data.</p> </li> <li> <p> <code>READWRITE</code> – Grant both read and write access to the S3 data.</p> </li> </ul>"""
    access_grants_location_id: NotRequired[
        "capo_s3_control.types.access_grants_location_id.AccessGrantsLocationId"
    ]
    """<p>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 <code>default</code> to the default location <code>s3://</code> and assigns an auto-generated ID to other locations that you register. </p>"""
    access_grants_location_configuration: NotRequired[
        "capo_s3_control.types.access_grants_location_configuration.AccessGrantsLocationConfiguration"
    ]
    """<p>The configuration options of the grant location. The grant location is the S3 path to the data to which you are granting access. </p>"""
    grant_scope: NotRequired["capo_s3_control.types.s3_prefix.S3Prefix"]
    """<p>The S3 path of the data to which you are granting access. It is the result of appending the <code>Subprefix</code> to the location scope.</p>"""
    application_arn: NotRequired[
        "capo_s3_control.types.identity_center_application_arn.IdentityCenterApplicationArn"
    ]
    """<p>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. </p>"""

access_grant_arn instance-attribute

access_grant_arn: NotRequired[AccessGrantArn]

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

access_grant_id instance-attribute

access_grant_id: NotRequired[AccessGrantId]

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

access_grants_location_configuration instance-attribute

access_grants_location_configuration: NotRequired[AccessGrantsLocationConfiguration]

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

access_grants_location_id instance-attribute

access_grants_location_id: NotRequired[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.

application_arn instance-attribute

application_arn: NotRequired[IdentityCenterApplicationArn]

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.

created_at instance-attribute

created_at: NotRequired[CreationTimestamp]

The date and time when you created the access grant.

grant_scope instance-attribute

grant_scope: NotRequired[S3Prefix]

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

grantee instance-attribute

grantee: NotRequired[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.

permission instance-attribute

permission: NotRequired[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.