Skip to content

GetDataAccessRequest

Source code in docs_src/capo_s3_control/types/get_data_access_request.py
class GetDataAccessRequest(TypedDict, closed=True):
    account_id: "capo_s3_control.types.account_id.AccountId"
    """<p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>"""
    target: "capo_s3_control.types.s3_prefix.S3Prefix"
    """<p>The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.</p>"""
    permission: "capo_s3_control.types.permission.Permission"
    """<p>The type of permission granted to your S3 data, which can be set to 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>"""
    duration_seconds: NotRequired[
        "capo_s3_control.types.duration_seconds.DurationSeconds"
    ]
    """<p>The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails. </p>"""
    privilege: NotRequired["capo_s3_control.types.privilege.Privilege"]
    """<p>The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application. </p> <ul> <li> <p> <code>Default</code> – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.</p> </li> <li> <p> <code>Minimal</code> – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope. </p> </li> </ul>"""
    target_type: NotRequired["capo_s3_control.types.s3_prefix_type.S3PrefixType"]
    """<p>The type of <code>Target</code>. The only possible value is <code>Object</code>. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix. </p>"""
    audit_context: NotRequired["capo_s3_control.types.audit_context.AuditContext"]
    """<p>The context to identify the job or query associated with the credential request. This information will be displayed in CloudTrail log in your account.</p>"""

account_id instance-attribute

account_id: AccountId

The Amazon Web Services account ID of the S3 Access Grants instance.

audit_context instance-attribute

audit_context: NotRequired[AuditContext]

The context to identify the job or query associated with the credential request. This information will be displayed in CloudTrail log in your account.

duration_seconds instance-attribute

duration_seconds: NotRequired[DurationSeconds]

The session duration, in seconds, of the temporary access credential that S3 Access Grants vends to the grantee or client application. The default value is 1 hour, but the grantee can specify a range from 900 seconds (15 minutes) up to 43200 seconds (12 hours). If the grantee requests a value higher than this maximum, the operation fails.

permission instance-attribute

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.

privilege instance-attribute

privilege: NotRequired[Privilege]

The scope of the temporary access credential that S3 Access Grants vends to the grantee or client application.

  • Default – The scope of the returned temporary access token is the scope of the grant that is closest to the target scope.

  • Minimal – The scope of the returned temporary access token is the same as the requested target scope as long as the requested scope is the same as or a subset of the grant scope.

target instance-attribute

target: S3Prefix

The S3 URI path of the data to which you are requesting temporary access credentials. If the requesting account has an access grant for this data, S3 Access Grants vends temporary access credentials in the response.

target_type instance-attribute

target_type: NotRequired[S3PrefixType]

The type of Target. The only possible value is Object. Pass this value if the target data that you would like to access is a path to an object. Do not pass this value if the target data is a bucket or a bucket and a prefix.