AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class ConflictException

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

Class CreateLinkRequest

Container for the parameters to the CreateLink operation. Creates a link between a source account and a sink that you have created in a monitoring account. After the link is created, data is sent from the source account to the monitoring account. When you create a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

For more information, see CreateSink and PutSinkPolicy.

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

Class CreateLinkResponse

This is the response object from the CreateLink operation.

Class CreateSinkRequest

Container for the parameters to the CreateSink operation. 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.

Class CreateSinkResponse

This is the response object from the CreateSink operation.

Class DeleteLinkRequest

Container for the parameters to the DeleteLink operation. Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.

Class DeleteLinkResponse

This is the response object from the DeleteLink operation.

Class DeleteSinkRequest

Container for the parameters to the DeleteSink operation. Deletes a sink. You must delete all links to a sink before you can delete that sink.

Class DeleteSinkResponse

This is the response object from the DeleteSink operation.

Class GetLinkRequest

Container for the parameters to the GetLink operation. Returns complete information about one link.

To use this operation, provide the link ARN. To retrieve a list of link ARNs, use ListLinks.

Class GetLinkResponse

This is the response object from the GetLink operation.

Class GetSinkPolicyRequest

Container for the parameters to the GetSinkPolicy operation. Returns the current sink policy attached to this sink. The sink policy specifies what accounts can attach to this sink as source accounts, and what types of data they can share.

Class GetSinkPolicyResponse

This is the response object from the GetSinkPolicy operation.

Class GetSinkRequest

Container for the parameters to the GetSink operation. Returns complete information about one monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

Class GetSinkResponse

This is the response object from the GetSink operation.

Class InternalServiceException

Unexpected error while processing the request. Retry the request.

Class InvalidParameterException

A parameter is specified incorrectly.

Class LinkConfiguration

Use this structure to optionally create filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account.

Class ListAttachedLinksItem

A structure that contains information about one link attached to this monitoring account sink.

Class ListAttachedLinksRequest

Container for the parameters to the ListAttachedLinks operation. Returns a list of source account links that are linked to this monitoring account sink.

To use this operation, provide the sink ARN. To retrieve a list of sink ARNs, use ListSinks.

To find a list of links for one source account, use ListLinks.

Class ListAttachedLinksResponse

This is the response object from the ListAttachedLinks operation.

Class ListLinksItem

A structure that contains information about one of this source account's links to a monitoring account.

Class ListLinksRequest

Container for the parameters to the ListLinks operation. Use this operation in a source account to return a list of links to monitoring account sinks that this source account has.

To find a list of links for one monitoring account sink, use ListAttachedLinks from within the monitoring account.

Class ListLinksResponse

This is the response object from the ListLinks operation.

Class ListSinksItem

A structure that contains information about one of this monitoring account's sinks.

Class ListSinksRequest

Container for the parameters to the ListSinks operation. Use this operation in a monitoring account to return the list of sinks created in that account.

Class ListSinksResponse

This is the response object from the ListSinks operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Displays the tags associated with a resource. Both sinks and links support tagging.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class LogGroupConfiguration

This structure contains the Filter parameter which you can use to specify which log groups are to share log events from this source account to the monitoring account.

Class MetricConfiguration

This structure contains the Filter parameter which you can use to specify which metric namespaces are to be shared from this source account to the monitoring account.

Class MissingRequiredParameterException

A required parameter is missing from the request.

Class OAMPaginatorFactory

Paginators for the OAM service

Class PutSinkPolicyRequest

Container for the parameters to the PutSinkPolicy operation. Creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. When you create a sink policy, you can grant permissions to all accounts in an organization or to individual accounts.

You can also use a sink policy to limit the types of data that is shared. The three types that you can allow or deny are:

  • Metrics - Specify with AWS::CloudWatch::Metric

  • Log groups - Specify with AWS::Logs::LogGroup

  • Traces - Specify with AWS::XRay::Trace

  • Application Insights - Applications - Specify with AWS::ApplicationInsights::Application

See the examples in this section to see how to specify permitted source accounts and data types.

Class PutSinkPolicyResponse

This is the response object from the PutSinkPolicy operation.

Class ResourceNotFoundException

The request references a resource that does not exist.

Class ServiceQuotaExceededException

The request would cause a service quota to be exceeded.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Assigns one or more tags (key-value pairs) to the specified resource. Both sinks and links can be tagged.

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.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:ResourceTag permission does not allow you to tag and untag links and sinks.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TooManyTagsException

A resource can have no more than 50 tags.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Removes one or more tags from the specified resource.

Unlike tagging permissions in other Amazon Web Services services, to tag or untag links and sinks you must have the oam:ResourceTag permission. The iam:TagResource permission does not allow you to tag and untag links and sinks.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateLinkRequest

Container for the parameters to the UpdateLink operation. Use this operation to change what types of data are shared from a source account to its linked monitoring account sink. You can't change the sink or change the monitoring account with this operation.

When you update a link, you can optionally specify filters that specify which metric namespaces and which log groups are shared from the source account to the monitoring account.

To update the list of tags associated with the sink, use TagResource.

Class UpdateLinkResponse

This is the response object from the UpdateLink operation.

Class ValidationException

The value of a parameter in the request caused an error.

Interfaces

NameDescription
Interface IListAttachedLinksPaginator

Paginator for the ListAttachedLinks operation

Interface IListLinksPaginator

Paginator for the ListLinks operation

Interface IListSinksPaginator

Paginator for the ListSinks operation

Interface IOAMPaginatorFactory

Paginators for the OAM service