ConfigService / Client / put_third_party_service_linked_configuration_recorder

put_third_party_service_linked_configuration_recorder

ConfigService.Client.put_third_party_service_linked_configuration_recorder(**kwargs)

Creates or updates a service-linked configuration recorder that is linked to a third-party cloud service provider based on the ConnectorArn you specify.

The configuration recorder’s name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder.

If a service-linked configuration recorder already exists for the specified service principal and connector, calling this operation again updates the ScopeConfiguration.

Note

This operation can only be called by the Amazon Web Services service linked to the configuration recorder

Customers cannot call this operation directly. Only the linked Amazon Web Services service can create or update the service-linked configuration recorder.

Note

Tags are added at creation and cannot be updated with this operation

Use TagResource and UntagResource to update tags after creation.

See also: AWS API Documentation

Request Syntax

response = client.put_third_party_service_linked_configuration_recorder(
    ServicePrincipal='string',
    ConnectorArn='string',
    ScopeConfiguration={
        'scopeType': 'string',
        'scopeValues': [
            'string',
        ],
        'allRegions': True|False,
        'includedRegions': [
            'string',
        ]
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • ServicePrincipal (string) –

    [REQUIRED]

    The service principal of the Amazon Web Services service for the service-linked configuration recorder that you want to create.

  • ConnectorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the connector that specifies the connection between the third-party cloud service provider and Config. The specified connector must exist.

  • ScopeConfiguration (dict) –

    [REQUIRED]

    Specifies the scope of resources to record from the third-party cloud service provider.

    • scopeType (string) – [REQUIRED]

      The type of scope for the third-party cloud resources. Valid values include:

      • tenant – Applies to all resources in an Azure tenant

      • subscription – Applies to resources in the Azure subscriptions you specify

      • organization – Applies to all resources in a Google Cloud organization

      • project – Applies to resources in the Google Cloud projects you specify

    • scopeValues (list) –

      The list of specific scope values for the third-party cloud resources. For example, a list of Azure subscription IDs, or a list of Google Cloud project IDs. Don’t specify scopeValues when scopeType is tenant or organization.

      • (string) –

    • allRegions (boolean) – [REQUIRED]

      Specifies whether to record resources from all supported regions for the third-party cloud service provider.

    • includedRegions (list) –

      The list of regions from the third-party cloud service provider to include when recording resources. Used when allRegions is set to false.

      • (string) –

  • Tags (list) –

    The tags for a service-linked configuration recorder. Each tag consists of a key and an optional value, both of which you define.

    • (dict) –

      The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

      • Key (string) –

        One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

      • Value (string) –

        The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Name': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the specified configuration recorder.

    • Name (string) –

      The name of the specified configuration recorder.

Exceptions