Skip to content

associate_iam_role_to_resource

associate_iam_role_to_resource(
    iam_role_arn: RoleArn,
    aws_integration: SupportedAwsIntegration,
    resource_arn: Arn,
    *,
    config_overrides: Optional[odbClientConfig] = None,
) -> AssociateIamRoleToResourceOutput

Associates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.

Parameters:

  • iam_role_arn (RoleArn) –

    The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role to associate with the resource.

  • aws_integration (SupportedAwsIntegration) –

    The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role association.

  • resource_arn (Arn) –

    The Amazon Resource Name (ARN) of the target resource to associate with the Amazon Web Services Identity and Access Management (IAM) service role.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

  • ConflictException –

    Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

  • InternalServerException –

    Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.

  • ResourceNotFoundException –

    The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to request throttling.

  • ValidationException –

    The request has failed validation because it is missing required fields or has invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_odb/_services/odb.py
def associate_iam_role_to_resource(
    self,
    iam_role_arn: "capo_odb.types.role_arn.RoleArn",
    aws_integration: "capo_odb.types.supported_aws_integration.SupportedAwsIntegration",
    resource_arn: "capo_odb.types.arn.Arn",
    *,
    config_overrides: Optional[odbClientConfig] = None,
) -> "capo_odb.types.associate_iam_role_to_resource_output.AssociateIamRoleToResourceOutput":
    """<p>Associates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.</p>

    Args:
        iam_role_arn: <p>The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) service role to associate with the resource.</p>
        aws_integration: <p>The Amazon Web Services integration configuration settings for the Amazon Web Services Identity and Access Management (IAM) service role association.</p>
        resource_arn: <p>The Amazon Resource Name (ARN) of the target resource to associate with the Amazon Web Services Identity and Access Management (IAM) service role.</p>

    Raises:
        capo_odb.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.</p>
        capo_odb.errors.conflict_exception.ConflictException: <p>Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.</p>
        capo_odb.errors.internal_server_exception.InternalServerException: <p>Occurs when there is an internal failure in the Oracle Database@Amazon Web Services service. Wait and try again.</p>
        capo_odb.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.</p>
        capo_odb.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_odb.errors.validation_exception.ValidationException: <p>The request has failed validation because it is missing required fields or has invalid inputs.</p>
        capo_odb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_odb.types.associate_iam_role_to_resource_input.AssociateIamRoleToResourceInput]",
    ) -> OperationResponse[
        "capo_odb.types.associate_iam_role_to_resource_output.AssociateIamRoleToResourceOutput"
    ]:
        import capo_odb._operations.odb.associate_iam_role_to_resource

        output, http_response = (
            capo_odb._operations.odb.associate_iam_role_to_resource.associate_iam_role_to_resource(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateIamRoleToResource")
    )
    input_: capo_odb.types.associate_iam_role_to_resource_input.AssociateIamRoleToResourceInput = {
        "iam_role_arn": iam_role_arn,
        "aws_integration": aws_integration,
        "resource_arn": resource_arn,
    }

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