CloudWatchObservabilityAccessManagerClient#
Index > CloudWatchObservabilityAccessManager > CloudWatchObservabilityAccessManagerClient
Auto-generated documentation for CloudWatchObservabilityAccessManager type annotations stubs module types-aiobotocore-oam.
CloudWatchObservabilityAccessManagerClient#
Type annotations and code completion for session.create_client("oam")
boto3 documentation
CloudWatchObservabilityAccessManagerClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_oam.client import CloudWatchObservabilityAccessManagerClient
session = get_session()
async with session.create_client("oam") as client:
client: CloudWatchObservabilityAccessManagerClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("oam").exceptions
structure.
CloudWatchObservabilityAccessManagerClient.exceptions usage example
async with session.create_client("oam") as client:
try:
do_something(client)
except (
client.ClientError,
client.ConflictException,
client.InternalServiceFault,
client.InvalidParameterException,
client.MissingRequiredParameterException,
client.ResourceNotFoundException,
client.ServiceQuotaExceededException,
client.TooManyTagsException,
client.ValidationException,
) as e:
print(e)
CloudWatchObservabilityAccessManagerClient usage type checking example
from types_aiobotocore_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 session.create_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 session.create_client("oam").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("oam").create_link
method.
boto3 documentation
# create_link method definition
await def create_link(
self,
*,
LabelTemplate: str,
ResourceTypes: Sequence[ResourceTypeType], # (1)
SinkIdentifier: str,
Tags: Mapping[str, str] = ...,
) -> CreateLinkOutputTypeDef: # (2)
...
# 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 session.create_client("oam").create_sink
method.
boto3 documentation
# create_sink method definition
await 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 session.create_client("oam").delete_link
method.
boto3 documentation
# delete_link method definition
await 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 session.create_client("oam").delete_sink
method.
boto3 documentation
# delete_sink method definition
await 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 session.create_client("oam").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("oam").get_link
method.
boto3 documentation
# get_link method definition
await 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 session.create_client("oam").get_sink
method.
boto3 documentation
# get_sink method definition
await 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 session.create_client("oam").get_sink_policy
method.
boto3 documentation
# get_sink_policy method definition
await def get_sink_policy(
self,
*,
SinkIdentifier: str,
) -> GetSinkPolicyOutputTypeDef: # (1)
...
# get_sink_policy method usage example with argument unpacking
kwargs: GetSinkPolicyInputRequestTypeDef = { # (1)
"SinkIdentifier": ...,
}
parent.get_sink_policy(**kwargs)
list_attached_links#
Returns a list of source account links that are linked to this monitoring account sink.
Type annotations and code completion for session.create_client("oam").list_attached_links
method.
boto3 documentation
# list_attached_links method definition
await def list_attached_links(
self,
*,
SinkIdentifier: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListAttachedLinksOutputTypeDef: # (1)
...
# list_attached_links method usage example with argument unpacking
kwargs: ListAttachedLinksInputRequestTypeDef = { # (1)
"SinkIdentifier": ...,
}
parent.list_attached_links(**kwargs)
list_links#
Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.
Type annotations and code completion for session.create_client("oam").list_links
method.
boto3 documentation
# list_links method definition
await def list_links(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListLinksOutputTypeDef: # (1)
...
# list_links method usage example with argument unpacking
kwargs: ListLinksInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_links(**kwargs)
list_sinks#
Use this operation in a monitoring account to return the list of sinks created in that account.
Type annotations and code completion for session.create_client("oam").list_sinks
method.
boto3 documentation
# list_sinks method definition
await def list_sinks(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListSinksOutputTypeDef: # (1)
...
# list_sinks method usage example with argument unpacking
kwargs: ListSinksInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_sinks(**kwargs)
list_tags_for_resource#
Displays the tags associated with a resource.
Type annotations and code completion for session.create_client("oam").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
put_sink_policy#
Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink.
Type annotations and code completion for session.create_client("oam").put_sink_policy
method.
boto3 documentation
# put_sink_policy method definition
await def put_sink_policy(
self,
*,
SinkIdentifier: str,
Policy: str,
) -> PutSinkPolicyOutputTypeDef: # (1)
...
# put_sink_policy method usage example with argument unpacking
kwargs: PutSinkPolicyInputRequestTypeDef = { # (1)
"SinkIdentifier": ...,
"Policy": ...,
}
parent.put_sink_policy(**kwargs)
tag_resource#
Assigns one or more tags (key-value pairs) to the specified resource.
Type annotations and code completion for session.create_client("oam").tag_resource
method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Removes one or more tags from the specified resource.
Type annotations and code completion for session.create_client("oam").untag_resource
method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceInputRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_link#
Use this operation to change what types of data are shared from a source account to its linked monitoring account sink.
Type annotations and code completion for session.create_client("oam").update_link
method.
boto3 documentation
# update_link method definition
await def update_link(
self,
*,
Identifier: str,
ResourceTypes: Sequence[ResourceTypeType], # (1)
) -> UpdateLinkOutputTypeDef: # (2)
...
# update_link method usage example with argument unpacking
kwargs: UpdateLinkInputRequestTypeDef = { # (1)
"Identifier": ...,
"ResourceTypes": ...,
}
parent.update_link(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("oam").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudWatchObservabilityAccessManagerClient:
...
__aexit__#
Type annotations and code completion for session.create_client("oam").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...
get_paginator#
Type annotations and code completion for session.create_client("oam").get_paginator
method with overloads.
client.get_paginator("list_attached_links")
-> ListAttachedLinksPaginatorclient.get_paginator("list_links")
-> ListLinksPaginatorclient.get_paginator("list_sinks")
-> ListSinksPaginator