Skip to content

update_configuration_definition async

update_configuration_definition(
    manager_arn: str,
    id: str,
    *,
    config_overrides: Optional[AsyncSSMQuickSetupClientConfig] = None,
    type_version: Optional[str] = None,
    parameters: Optional[ConfigurationParametersMap] = None,
    local_deployment_execution_role_name: Optional[str] = None,
    local_deployment_administration_role_arn: Optional[IAMRoleArn] = None,
) -> None

Updates a Quick Setup configuration definition.

Parameters:

  • manager_arn (str) –

    The ARN of the configuration manager associated with the definition to update.

  • id (str) –

    The ID of the configuration definition you want to update.

  • type_version (Optional[str], default: None ) –

    The version of the Quick Setup type to use.

  • parameters (Optional[ConfigurationParametersMap], default: None ) –

    The parameters for the configuration definition type.

  • local_deployment_execution_role_name (Optional[str], default: None ) –

    The name of the IAM role used to deploy local configurations.

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

    The ARN of the IAM role used to administrate local configuration deployments.

Raises:

Source code in docs_src/capo_ssm_quicksetup/_services/async_ssm_quick_setup.py
async def update_configuration_definition(
    self,
    manager_arn: str,
    id: str,
    *,
    config_overrides: Optional[AsyncSSMQuickSetupClientConfig] = None,
    type_version: Optional[str] = None,
    parameters: Optional[
        "capo_ssm_quicksetup.types.configuration_parameters_map.ConfigurationParametersMap"
    ] = None,
    local_deployment_execution_role_name: Optional[str] = None,
    local_deployment_administration_role_arn: Optional[
        "capo_ssm_quicksetup.types.iam_role_arn.IAMRoleArn"
    ] = None,
) -> None:
    """<p>Updates a Quick Setup configuration definition.</p>

    Args:
        manager_arn: <p>The ARN of the configuration manager associated with the definition to update.</p>
        id: <p>The ID of the configuration definition you want to update.</p>
        type_version: <p>The version of the Quick Setup type to use.</p>
        parameters: <p>The parameters for the configuration definition type.</p>
        local_deployment_execution_role_name: <p>The name of the IAM role used to deploy local configurations.</p>
        local_deployment_administration_role_arn: <p>The ARN of the IAM role used to administrate local configuration deployments.</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.resource_not_found_exception.ResourceNotFoundException: <p>The resource couldn't be found. Check the ID or name and try again.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ssm_quicksetup.types.update_configuration_definition_input.UpdateConfigurationDefinitionInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_ssm_quicksetup._operations.quick_setup.update_configuration_definition

        (
            output,
            http_response,
        ) = await capo_ssm_quicksetup._operations.quick_setup.update_configuration_definition.async_update_configuration_definition(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConfigurationDefinition")
    )
    input_: capo_ssm_quicksetup.types.update_configuration_definition_input.UpdateConfigurationDefinitionInput = {
        "manager_arn": manager_arn,
        "id": id,
    }
    if type_version is not None:
        input_["type_version"] = type_version
    if parameters is not None:
        input_["parameters"] = parameters
    if local_deployment_execution_role_name is not None:
        input_["local_deployment_execution_role_name"] = (
            local_deployment_execution_role_name
        )
    if local_deployment_administration_role_arn is not None:
        input_["local_deployment_administration_role_arn"] = (
            local_deployment_administration_role_arn
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output