Skip to content

update_service_settings

update_service_settings(
    *,
    config_overrides: Optional[SSMQuickSetupClientConfig] = None,
    explorer_enabling_role_arn: Optional[IAMRoleArn] = None,
) -> None

Updates settings configured for Quick Setup.

Parameters:

  • explorer_enabling_role_arn (Optional[IAMRoleArn], default: None ) –

    The IAM role used to enable Explorer.

Raises:

  • AccessDeniedException –

    The requester has insufficient permissions to perform the operation.

  • ConflictException –

    Another request is being processed. Wait a few minutes and try again.

  • InternalServerException –

    An error occurred on the server side.

  • ThrottlingException –

    The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.

  • ValidationException –

    The request is invalid. Verify the values provided for the request parameters are accurate.

  • UnknownServiceError –

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

Source code in docs_src/capo_ssm_quicksetup/_services/ssm_quick_setup.py
def update_service_settings(
    self,
    *,
    config_overrides: Optional[SSMQuickSetupClientConfig] = None,
    explorer_enabling_role_arn: Optional[
        "capo_ssm_quicksetup.types.iam_role_arn.IAMRoleArn"
    ] = None,
) -> None:
    """<p>Updates settings configured for Quick Setup.</p>

    Args:
        explorer_enabling_role_arn: <p>The IAM role used to enable Explorer.</p>

    Raises:
        capo_ssm_quicksetup.errors.access_denied_exception.AccessDeniedException: <p>The requester has insufficient permissions to perform the operation.</p>
        capo_ssm_quicksetup.errors.conflict_exception.ConflictException: <p>Another request is being processed. Wait a few minutes and try again.</p>
        capo_ssm_quicksetup.errors.internal_server_exception.InternalServerException: <p>An error occurred on the server side.</p>
        capo_ssm_quicksetup.errors.throttling_exception.ThrottlingException: <p>The request or operation exceeds the maximum allowed request rate per Amazon Web Services account and Amazon Web Services Region.</p>
        capo_ssm_quicksetup.errors.validation_exception.ValidationException: <p>The request is invalid. Verify the values provided for the request parameters are accurate.</p>
        capo_ssm_quicksetup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ssm_quicksetup.types.update_service_settings_input.UpdateServiceSettingsInput]",
    ) -> OperationResponse[None]:
        import capo_ssm_quicksetup._operations.quick_setup.update_service_settings

        output, http_response = (
            capo_ssm_quicksetup._operations.quick_setup.update_service_settings.update_service_settings(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateServiceSettings")
    )
    input_: capo_ssm_quicksetup.types.update_service_settings_input.UpdateServiceSettingsInput = {}
    if explorer_enabling_role_arn is not None:
        input_["explorer_enabling_role_arn"] = explorer_enabling_role_arn

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