CloudWatchObservabilityAccessManagerClient#
Index > CloudWatchObservabilityAccessManager > CloudWatchObservabilityAccessManagerClient
Auto-generated documentation for CloudWatchObservabilityAccessManager type annotations stubs module mypy-boto3-oam.
CloudWatchObservabilityAccessManagerClient#
Type annotations and code completion for boto3.client("oam")
.
boto3 documentation
# CloudWatchObservabilityAccessManagerClient usage example
from boto3.session import Session
from mypy_boto3_oam.client import CloudWatchObservabilityAccessManagerClient
def get_oam_client() -> CloudWatchObservabilityAccessManagerClient:
return Session().client("oam")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("oam").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("oam")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.InternalServiceFault,
client.exceptions.InvalidParameterException,
client.exceptions.MissingRequiredParameterException,
client.exceptions.ResourceNotFoundException,
client.exceptions.ServiceQuotaExceededException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_oam.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("oam").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("oam").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_link#
Creates a link between a source account and a sink that you have created in a monitoring account.
Type annotations and code completion for boto3.client("oam").create_link
method.
boto3 documentation
# create_link method definition
def create_link(
self,
*,
LabelTemplate: str,
ResourceTypes: Sequence[ResourceTypeType], # (1)
SinkIdentifier: str,
LinkConfiguration: LinkConfigurationTypeDef = ..., # (2)
Tags: Mapping[str, str] = ...,
) -> CreateLinkOutputTypeDef: # (3)
...
# create_link method usage example with argument unpacking
kwargs: CreateLinkInputRequestTypeDef = { # (1)
"LabelTemplate": ...,
"ResourceTypes": ...,
"SinkIdentifier": ...,
}
parent.create_link(**kwargs)
create_sink#
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.
Type annotations and code completion for boto3.client("oam").create_sink
method.
boto3 documentation
# create_sink method definition
def create_sink(
self,
*,
Name: str,
Tags: Mapping[str, str] = ...,
) -> CreateSinkOutputTypeDef: # (1)
...
# create_sink method usage example with argument unpacking
kwargs: CreateSinkInputRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_sink(**kwargs)
delete_link#
Deletes a link between a monitoring account sink and a source account.
Type annotations and code completion for boto3.client("oam").delete_link
method.
boto3 documentation
# delete_link method definition
def delete_link(
self,
*,
Identifier: str,
) -> Dict[str, Any]:
...
# delete_link method usage example with argument unpacking
kwargs: DeleteLinkInputRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_link(**kwargs)
delete_sink#
Deletes a sink.
Type annotations and code completion for boto3.client("oam").delete_sink
method.
boto3 documentation
# delete_sink method definition
def delete_sink(
self,
*,
Identifier: str,
) -> Dict[str, Any]:
...
# delete_sink method usage example with argument unpacking
kwargs: DeleteSinkInputRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.delete_sink(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("oam").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_link#
Returns complete information about one link.
Type annotations and code completion for boto3.client("oam").get_link
method.
boto3 documentation
# get_link method definition
def get_link(
self,
*,
Identifier: str,
) -> GetLinkOutputTypeDef: # (1)
...
# get_link method usage example with argument unpacking
kwargs: GetLinkInputRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.get_link(**kwargs)
get_sink#
Returns complete information about one monitoring account sink.
Type annotations and code completion for boto3.client("oam").get_sink
method.
boto3 documentation
# get_sink method definition
def get_sink(
self,
*,
Identifier: str,
) -> GetSinkOutputTypeDef: # (1)
...
# get_sink method usage example with argument unpacking
kwargs: GetSinkInputRequestTypeDef = { # (1)
"Identifier": ...,
}
parent.get_sink(**kwargs)
get_sink_policy#
Returns the current sink policy attached to this sink.
Type annotations and code completion for boto3.client("oam").get_sink_policy
method.