create_sink `async` ¶

create_sink(
    name: SinkName,
    *,
    config_overrides: Optional[AsyncOAMClientConfig] = None,
    tags: Optional[TagMapInput] = None,
) -> CreateSinkOutput

Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.

Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.

Parameters:

name (SinkName) –

A name for the sink.
tags (Optional[TagMapInput], default: None ) –

Assigns one or more tags (key-value pairs) to the link.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

Raises:

ConflictException –

A resource was in an inconsistent state during an update or a deletion.
InternalServiceFault –

Unexpected error while processing the request. Retry the request.
InvalidParameterException –

A parameter is specified incorrectly.
MissingRequiredParameterException –

A required parameter is missing from the request.
ServiceQuotaExceededException –

The request would cause a service quota to be exceeded.
UnknownServiceError –

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

Source code in docs_src/capo_oam/_services/async_oam.py

async def create_sink(
    self,
    name: "capo_oam.types.sink_name.SinkName",
    *,
    config_overrides: Optional[AsyncOAMClientConfig] = None,
    tags: Optional["capo_oam.types.tag_map_input.TagMapInput"] = None,
) -> "capo_oam.types.create_sink_output.CreateSinkOutput":
    """<p>Use this to create a <i>sink</i> in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.</p> <p>After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see <a href="https://docs.aws.amazon.com/OAM/latest/APIReference/API_PutSinkPolicy.html">PutSinkPolicy</a>.</p> <p>Each account can contain one sink per Region. If you delete a sink, you can then create a new one in that Region.</p>

    Args:
        name: <p>A name for the sink.</p>
        tags: <p>Assigns one or more tags (key-value pairs) to the link. </p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.</p> <p>For more information about using tags to control access, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">Controlling access to Amazon Web Services resources using tags</a>.</p>

    Raises:
        capo_oam.errors.conflict_exception.ConflictException: <p>A resource was in an inconsistent state during an update or a deletion.</p>
        capo_oam.errors.internal_service_fault.InternalServiceFault: <p>Unexpected error while processing the request. Retry the request.</p>
        capo_oam.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_oam.errors.missing_required_parameter_exception.MissingRequiredParameterException: <p>A required parameter is missing from the request.</p>
        capo_oam.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause a service quota to be exceeded.</p>
        capo_oam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_oam.types.create_sink_input.CreateSinkInput]",
    ) -> AsyncOperationResponse[
        "capo_oam.types.create_sink_output.CreateSinkOutput"
    ]:
        import capo_oam._operations.oamservice.create_sink

        (
            output,
            http_response,
        ) = await capo_oam._operations.oamservice.create_sink.async_create_sink(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateSink")
    )
    input_: capo_oam.types.create_sink_input.CreateSinkInput = {"name": name}
    if tags is not None:
        input_["tags"] = tags

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

create_sink async ¶

create_sink `async` ¶