CreateLink

$result = $client->createLink([/* ... */]);
$promise = $client->createLinkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLink([
    'LabelTemplate' => '<string>', // REQUIRED
    'LinkConfiguration' => [
        'LogGroupConfiguration' => [
            'Filter' => '<string>', // REQUIRED
        ],
        'MetricConfiguration' => [
            'Filter' => '<string>', // REQUIRED
        ],
    ],
    'ResourceTypes' => ['<string>', ...], // REQUIRED
    'SinkIdentifier' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Label' => '<string>',
    'LabelTemplate' => '<string>',
    'LinkConfiguration' => [
        'LogGroupConfiguration' => [
            'Filter' => '<string>',
        ],
        'MetricConfiguration' => [
            'Filter' => '<string>',
        ],
    ],
    'ResourceTypes' => ['<string>', ...],
    'SinkArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

ConflictException:

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

MissingRequiredParameterException:

A required parameter is missing from the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InvalidParameterException:

A parameter is specified incorrectly.

CreateSink

$result = $client->createSink([/* ... */]);
$promise = $client->createSinkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createSink([
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

ConflictException:

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

MissingRequiredParameterException:

A required parameter is missing from the request.

ServiceQuotaExceededException:

The request would cause a service quota to be exceeded.

InvalidParameterException:

A parameter is specified incorrectly.

DeleteLink

$result = $client->deleteLink([/* ... */]);
$promise = $client->deleteLinkAsync([/* ... */]);

Deletes a link between a monitoring account sink and a source account. You must run this operation in the source account.

Parameter Syntax

$result = $client->deleteLink([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

DeleteSink

$result = $client->deleteSink([/* ... */]);
$promise = $client->deleteSinkAsync([/* ... */]);

Deletes a sink. You must delete all links to a sink before you can delete that sink.

Parameter Syntax

$result = $client->deleteSink([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

ConflictException:

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

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

GetLink

$result = $client->getLink([/* ... */]);
$promise = $client->getLinkAsync([/* ... */]);

Returns complete information about one link.

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

Parameter Syntax

$result = $client->getLink([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Label' => '<string>',
    'LabelTemplate' => '<string>',
    'LinkConfiguration' => [
        'LogGroupConfiguration' => [
            'Filter' => '<string>',
        ],
        'MetricConfiguration' => [
            'Filter' => '<string>',
        ],
    ],
    'ResourceTypes' => ['<string>', ...],
    'SinkArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

GetSink

$result = $client->getSink([/* ... */]);
$promise = $client->getSinkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSink([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Name' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

GetSinkPolicy

$result = $client->getSinkPolicy([/* ... */]);
$promise = $client->getSinkPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getSinkPolicy([
    'SinkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'SinkArn' => '<string>',
    'SinkId' => '<string>',
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

ListAttachedLinks

$result = $client->listAttachedLinks([/* ... */]);
$promise = $client->listAttachedLinksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAttachedLinks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SinkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Label' => '<string>',
            'LinkArn' => '<string>',
            'ResourceTypes' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

ListLinks

$result = $client->listLinks([/* ... */]);
$promise = $client->listLinksAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listLinks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Label' => '<string>',
            'ResourceTypes' => ['<string>', ...],
            'SinkArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

ListSinks

$result = $client->listSinks([/* ... */]);
$promise = $client->listSinksAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listSinks([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Items' => [
        [
            'Arn' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Displays the tags associated with a resource. Both sinks and links support tagging.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

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

ResourceNotFoundException:

The request references a resource that does not exist.

PutSinkPolicy

$result = $client->putSinkPolicy([/* ... */]);
$promise = $client->putSinkPolicyAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->putSinkPolicy([
    'Policy' => '<string>', // REQUIRED
    'SinkIdentifier' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'SinkArn' => '<string>',
    'SinkId' => '<string>',
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

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

TooManyTagsException:

A resource can have no more than 50 tags.

ResourceNotFoundException:

The request references a resource that does not exist.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from the specified resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

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

ResourceNotFoundException:

The request references a resource that does not exist.

UpdateLink

$result = $client->updateLink([/* ... */]);
$promise = $client->updateLinkAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateLink([
    'Identifier' => '<string>', // REQUIRED
    'LinkConfiguration' => [
        'LogGroupConfiguration' => [
            'Filter' => '<string>', // REQUIRED
        ],
        'MetricConfiguration' => [
            'Filter' => '<string>', // REQUIRED
        ],
    ],
    'ResourceTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Arn' => '<string>',
    'Id' => '<string>',
    'Label' => '<string>',
    'LabelTemplate' => '<string>',
    'LinkConfiguration' => [
        'LogGroupConfiguration' => [
            'Filter' => '<string>',
        ],
        'MetricConfiguration' => [
            'Filter' => '<string>',
        ],
    ],
    'ResourceTypes' => ['<string>', ...],
    'SinkArn' => '<string>',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServiceFault:

Unexpected error while processing the request. Retry the request.

MissingRequiredParameterException:

A required parameter is missing from the request.

InvalidParameterException:

A parameter is specified incorrectly.

ResourceNotFoundException:

The request references a resource that does not exist.