Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.
Parameters:
-
application_id
(ApplicationId)
–
The unique identifier of the Amazon Q Business application.
Raises:
-
AccessDeniedException
–
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
-
InternalServerException
–
An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
-
ResourceNotFoundException
–
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
-
ThrottlingException
–
The request was denied due to throttling. Reduce the number of requests and try again.
-
ValidationException
–
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_qbusiness/_services/q_business.py
| def get_policy(
self,
application_id: "capo_qbusiness.types.application_id.ApplicationId",
*,
config_overrides: Optional[QBusinessClientConfig] = None,
) -> "capo_qbusiness.types.get_policy_response.GetPolicyResponse":
"""<p>Retrieves the current permission policy for a Amazon Q Business application. The policy is returned as a JSON-formatted string and defines the IAM actions that are allowed or denied for the application's resources.</p>
Args:
application_id: <p>The unique identifier of the Amazon Q Business application.</p>
Raises:
capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_qbusiness.types.get_policy_request.GetPolicyRequest]",
) -> OperationResponse[
"capo_qbusiness.types.get_policy_response.GetPolicyResponse"
]:
import capo_qbusiness._operations.expert_q.get_policy
output, http_response = (
capo_qbusiness._operations.expert_q.get_policy.get_policy(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetPolicy")
)
input_: capo_qbusiness.types.get_policy_request.GetPolicyRequest = {
"application_id": application_id
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|