Skip to content

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:
    ...

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)
    ...
  1. See ResourceTypeType
  2. See LinkConfigurationTypeDef
  3. See CreateLinkOutputTypeDef 
# create_link method usage example with argument unpacking

kwargs: CreateLinkInputRequestTypeDef = {  # (1)
    "LabelTemplate": ...,
    "ResourceTypes": ...,
    "SinkIdentifier": ...,
}

parent.create_link(**kwargs)
  1. See CreateLinkInputRequestTypeDef

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)
    ...
  1. See CreateSinkOutputTypeDef 
# create_sink method usage example with argument unpacking

kwargs: CreateSinkInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_sink(**kwargs)
  1. See CreateSinkInputRequestTypeDef

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)
  1. See DeleteLinkInputRequestTypeDef

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)
  1. See DeleteSinkInputRequestTypeDef

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:
    ...

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)
    ...
  1. See GetLinkOutputTypeDef 
# get_link method usage example with argument unpacking

kwargs: GetLinkInputRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_link(**kwargs)
  1. See GetLinkInputRequestTypeDef

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)
    ...
  1. See GetSinkOutputTypeDef 
# get_sink method usage example with argument unpacking

kwargs: GetSinkInputRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_sink(**kwargs)
  1. See GetSinkInputRequestTypeDef

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. boto3 documentation

# get_sink_policy method definition

def get_sink_policy(
    self,
    *,
    SinkIdentifier: str,
) -> GetSinkPolicyOutputTypeDef:  # (1)
    ...
  1. See GetSinkPolicyOutputTypeDef 
# get_sink_policy method usage example with argument unpacking

kwargs: GetSinkPolicyInputRequestTypeDef = {  # (1)
    "SinkIdentifier": ...,
}

parent.get_sink_policy(**kwargs)
  1. See GetSinkPolicyInputRequestTypeDef

Returns a list of source account links that are linked to this monitoring account sink.

Type annotations and code completion for boto3.client("oam").list_attached_links method. boto3 documentation

# list_attached_links method definition

def list_attached_links(
    self,
    *,
    SinkIdentifier: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListAttachedLinksOutputTypeDef:  # (1)
    ...
  1. See ListAttachedLinksOutputTypeDef 
# list_attached_links method usage example with argument unpacking

kwargs: ListAttachedLinksInputRequestTypeDef = {  # (1)
    "SinkIdentifier": ...,
}

parent.list_attached_links(**kwargs)
  1. See ListAttachedLinksInputRequestTypeDef

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 boto3.client("oam").list_links method. boto3 documentation

# list_links method definition

def list_links(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListLinksOutputTypeDef:  # (1)
    ...
  1. See ListLinksOutputTypeDef 
# list_links method usage example with argument unpacking

kwargs: ListLinksInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_links(**kwargs)
  1. See ListLinksInputRequestTypeDef

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 boto3.client("oam").list_sinks method. boto3 documentation

# list_sinks method definition

def list_sinks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSinksOutputTypeDef:  # (1)
    ...
  1. See ListSinksOutputTypeDef 
# list_sinks method usage example with argument unpacking

kwargs: ListSinksInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_sinks(**kwargs)
  1. See ListSinksInputRequestTypeDef

list_tags_for_resource#

Displays the tags associated with a resource.

Type annotations and code completion for boto3.client("oam").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

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 boto3.client("oam").put_sink_policy method. boto3 documentation

# put_sink_policy method definition

def put_sink_policy(
    self,
    *,
    Policy: str,
    SinkIdentifier: str,
) -> PutSinkPolicyOutputTypeDef:  # (1)
    ...
  1. See PutSinkPolicyOutputTypeDef 
# put_sink_policy method usage example with argument unpacking

kwargs: PutSinkPolicyInputRequestTypeDef = {  # (1)
    "Policy": ...,
    "SinkIdentifier": ...,
}

parent.put_sink_policy(**kwargs)
  1. See PutSinkPolicyInputRequestTypeDef

tag_resource#

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

Type annotations and code completion for boto3.client("oam").tag_resource method. boto3 documentation

# tag_resource method definition

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)
  1. See TagResourceInputRequestTypeDef

untag_resource#

Removes one or more tags from the specified resource.

Type annotations and code completion for boto3.client("oam").untag_resource method. boto3 documentation

# untag_resource method definition

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)
  1. See UntagResourceInputRequestTypeDef

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 boto3.client("oam").update_link method. boto3 documentation

# update_link method definition

def update_link(
    self,
    *,
    Identifier: str,
    ResourceTypes: Sequence[ResourceTypeType],  # (1)
    LinkConfiguration: LinkConfigurationTypeDef = ...,  # (2)
) -> UpdateLinkOutputTypeDef:  # (3)
    ...
  1. See ResourceTypeType
  2. See LinkConfigurationTypeDef
  3. See UpdateLinkOutputTypeDef 
# update_link method usage example with argument unpacking

kwargs: UpdateLinkInputRequestTypeDef = {  # (1)
    "Identifier": ...,
    "ResourceTypes": ...,
}

parent.update_link(**kwargs)
  1. See UpdateLinkInputRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("oam").get_paginator method with overloads.