Skip to content

update_site async

update_site(
    site_id: SiteId,
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
    name: Optional[SiteName] = None,
    description: Optional[SiteDescription] = None,
    notes: Optional[SiteNotes] = None,
) -> UpdateSiteOutput

Updates the specified site.

Parameters:

  • site_id (SiteId) –

    The ID or the Amazon Resource Name (ARN) of the site.

  • notes (Optional[SiteNotes], default: None ) –

    Notes about a site.

Raises:

Source code in docs_src/capo_outposts/_services/async_outposts.py
async def update_site(
    self,
    site_id: "capo_outposts.types.site_id.SiteId",
    *,
    config_overrides: Optional[AsyncOutpostsClientConfig] = None,
    name: Optional["capo_outposts.types.site_name.SiteName"] = None,
    description: Optional[
        "capo_outposts.types.site_description.SiteDescription"
    ] = None,
    notes: Optional["capo_outposts.types.site_notes.SiteNotes"] = None,
) -> "capo_outposts.types.update_site_output.UpdateSiteOutput":
    """<p>Updates the specified site.</p>

    Args:
        site_id: <p> The ID or the Amazon Resource Name (ARN) of the site. </p>
        notes: <p>Notes about a site.</p>

    Raises:
        capo_outposts.errors.access_denied_exception.AccessDeniedException: <p>You do not have permission to perform this operation.</p>
        capo_outposts.errors.conflict_exception.ConflictException: <p>Updating or deleting this resource can cause an inconsistent state.</p>
        capo_outposts.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred.</p>
        capo_outposts.errors.not_found_exception.NotFoundException: <p>The specified request is not valid.</p>
        capo_outposts.errors.validation_exception.ValidationException: <p>A parameter is not valid.</p>
        capo_outposts.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_outposts.types.update_site_input.UpdateSiteInput]",
    ) -> AsyncOperationResponse[
        "capo_outposts.types.update_site_output.UpdateSiteOutput"
    ]:
        import capo_outposts._operations.outposts_olaf_service.update_site

        (
            output,
            http_response,
        ) = await capo_outposts._operations.outposts_olaf_service.update_site.async_update_site(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSite")
    )
    input_: capo_outposts.types.update_site_input.UpdateSiteInput = {
        "site_id": site_id
    }
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if notes is not None:
        input_["notes"] = notes

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