configurations

Creates, updates, deletes, gets or lists a configurations resource.

Overview

Name	configurations
Type	Resource
Id	aws.discovery.configurations

Fields

The following fields are returned by SELECT queries:

describe_configurations

Name	Datatype	Description
configuration	object	A key in the response map. The value is an array of data.

list_configurations

Name	Datatype	Description
configuration	object	Returns configuration details, including the configuration ID, attribute names, and attribute values.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_configurations	select	region		Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server application process connection Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc. For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.
list_configurations	select	region		Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.
associate_configuration_items_to_application	update	region, applicationConfigurationId, configurationIds		Associates one or more configuration items with an application.
disassociate_configuration_items_from_application	exec	region, applicationConfigurationId, configurationIds		Disassociates one or more configuration items from an application.
export_configurations	exec	region		Deprecated. Use StartExportTask instead. Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.
start_batch_delete_configuration_task	exec	region, configurationType, configurationIds		Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_configurations

Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type from one of the following: server application process connection Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc. For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action in the Amazon Web Services Application Discovery Service User Guide.

SELECT
configuration
FROM aws.discovery.configurations
WHERE region = '{{ region }}' -- required
;

list_configurations

Retrieves a list of configuration items as specified by the value passed to the required parameter configurationType. Optional filtering may be applied to refine search results.

SELECT
configuration
FROM aws.discovery.configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

associate_configuration_items_to_application

Associates one or more configuration items with an application.

UPDATE aws.discovery.configurations
SET 
applicationConfigurationId = '{{ applicationConfigurationId }}',
configurationIds = '{{ configurationIds }}'
WHERE 
region = '{{ region }}' --required
AND applicationConfigurationId = '{{ applicationConfigurationId }}' --required
AND configurationIds = '{{ configurationIds }}' --required;

Lifecycle Methods

disassociate_configuration_items_from_application

Disassociates one or more configuration items from an application.

EXEC aws.discovery.configurations.disassociate_configuration_items_from_application 
@region='{{ region }}' --required 
@@json=
'{
"applicationConfigurationId": "{{ applicationConfigurationId }}", 
"configurationIds": "{{ configurationIds }}"
}'
;

export_configurations

Deprecated. Use StartExportTask instead. Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

EXEC aws.discovery.configurations.export_configurations 
@region='{{ region }}' --required 
;

start_batch_delete_configuration_task

Takes a list of configurationId as input and starts an asynchronous deletion task to remove the configurationItems. Returns a unique deletion task identifier.

EXEC aws.discovery.configurations.start_batch_delete_configuration_task 
@region='{{ region }}' --required 
@@json=
'{
"configurationType": "{{ configurationType }}", 
"configurationIds": "{{ configurationIds }}"
}'
;