ConfigService / Client / put_resource_config

put_resource_config#

ConfigService.Client.put_resource_config(**kwargs)#

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.

Note

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.

See also: AWS API Documentation

Request Syntax

response = client.put_resource_config(
    ResourceType='string',
    SchemaVersionId='string',
    ResourceId='string',
    ResourceName='string',
    Configuration='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • ResourceType (string) –

    [REQUIRED]

    The type of the resource. The custom resource type must be registered with CloudFormation.

    Note

    You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

  • SchemaVersionId (string) –

    [REQUIRED]

    Version of the schema registered for the ResourceType in CloudFormation.

  • ResourceId (string) –

    [REQUIRED]

    Unique identifier of the resource.

  • ResourceName (string) – Name of the resource.

  • Configuration (string) –

    [REQUIRED]

    The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

    Note

    The configuration JSON must not exceed 64 KB.

  • Tags (dict) –

    Tags associated with the resource.

    Note

    This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

    • (string) –

      • (string) –

Returns:

None

Exceptions

  • ConfigService.Client.exceptions.ValidationException

  • ConfigService.Client.exceptions.InsufficientPermissionsException

  • ConfigService.Client.exceptions.NoRunningConfigurationRecorderException

  • ConfigService.Client.exceptions.MaxActiveResourcesExceededException