Retrieves the S3 Access Grants instance for a Region in your account.
- Permissions
-
You must have the s3:GetAccessGrantsInstance permission to use this operation.
GetAccessGrantsInstance is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.
Parameters:
-
account_id
(AccountId)
–
The Amazon Web Services account ID of the S3 Access Grants instance.
Raises:
Source code in docs_src/capo_s3_control/_services/s3_control.py
| def get_access_grants_instance(
self,
account_id: "capo_s3_control.types.account_id.AccountId",
*,
config_overrides: Optional[S3ControlClientConfig] = None,
) -> "capo_s3_control.types.get_access_grants_instance_result.GetAccessGrantsInstanceResult":
"""<p>Retrieves the S3 Access Grants instance for a Region in your account. </p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3:GetAccessGrantsInstance</code> permission to use this operation. </p> </dd> </dl> <note> <p> <code>GetAccessGrantsInstance</code> is not supported for cross-account access. You can only call the API from the account that owns the S3 Access Grants instance.</p> </note>
Args:
account_id: <p>The Amazon Web Services account ID of the S3 Access Grants instance.</p>
Raises:
capo_s3_control.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_s3_control.types.get_access_grants_instance_request.GetAccessGrantsInstanceRequest]",
) -> OperationResponse[
"capo_s3_control.types.get_access_grants_instance_result.GetAccessGrantsInstanceResult"
]:
import capo_s3_control._operations.awss3_control_service_v20180820.get_access_grants_instance
output, http_response = (
capo_s3_control._operations.awss3_control_service_v20180820.get_access_grants_instance.get_access_grants_instance(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetAccessGrantsInstance")
)
input_: capo_s3_control.types.get_access_grants_instance_request.GetAccessGrantsInstanceRequest = {
"account_id": account_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|