Skip to content

attach_policy 

attach_policy(
    policy_name: PolicyName,
    target: PolicyTarget,
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> None

Attaches the specified policy to the specified principal (certificate or other credential).

Requires permission to access the AttachPolicy action.

Parameters:

  • policy_name (PolicyName) –

    The name of the policy to attach.

  • target (PolicyTarget) –

    The identity to which the policy is attached. For example, a thing group or a certificate.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py 
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
def attach_policy(
    self,
    policy_name: "capo_iot.types.policy_name.PolicyName",
    target: "capo_iot.types.policy_target.PolicyTarget",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> None:
    """<p>Attaches the specified policy to the specified principal (certificate or other credential).</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AttachPolicy</a> action.</p>

    Args:
        policy_name: <p>The name of the policy to attach.</p>
        target: <p>The <a href="https://docs.aws.amazon.com/iot/latest/developerguide/security-iam.html">identity</a> to which the policy is attached. For example, a thing group or a certificate.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.limit_exceeded_exception.LimitExceededException: <p>A limit has been exceeded.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.attach_policy_request.AttachPolicyRequest]",
    ) -> OperationResponse[None]:
        import capo_iot._operations.aws_iot_service.attach_policy

        output, http_response = (
            capo_iot._operations.aws_iot_service.attach_policy.attach_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AttachPolicy")
    )
    input_: capo_iot.types.attach_policy_request.AttachPolicyRequest = {
        "policy_name": policy_name,
        "target": target,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output