ops_metadatas

Creates, updates, deletes, gets or lists an ops_metadatas resource.

Overview

Name	ops_metadatas
Type	Resource
Id	aws.ssm.ops_metadatas

Fields

The following fields are returned by SELECT queries:

get_ops_metadata

Name	Datatype	Description
metadata	object	OpsMetadata for an Application Manager application.
next_token	string	The token for the next set of items to return. Use this token to get the next set of results.
resource_id	string	The resource ID of the Application Manager application. (pattern: <code>^(?!\s*$).+</code>)

list_ops_metadata

Name	Datatype	Description
creation_date	string (date-time)	The date the OpsMetadata objects was created.
last_modified_date	string (date-time)	The date the OpsMetadata object was last updated.
last_modified_user	string	The user name who last updated the OpsMetadata object.
ops_metadata_arn	string	The Amazon Resource Name (ARN) of the OpsMetadata Object or blob. (pattern: <code>arn:(aws[a-zA-Z-])?:ssm:[a-z0-9-.]{0,63}:[a-z0-9-.]{0,63}:opsmetadata/([a-zA-Z0-9-_./])</code>)
resource_id	string	The ID of the Application Manager application. (pattern: <code>^(?!\s*$).+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_ops_metadata	select	region		View operational metadata related to an application in Application Manager.
list_ops_metadata	select	region		Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.
create_ops_metadata	insert	region, ResourceId		If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.
update_ops_metadata	update	region, OpsMetadataArn		Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.
delete_ops_metadata	delete	region		Delete OpsMetadata related to an application.

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

get_ops_metadata

View operational metadata related to an application in Application Manager.

SELECT
metadata,
next_token,
resource_id
FROM aws.ssm.ops_metadatas
WHERE region = '{{ region }}' -- required
;

list_ops_metadata

Amazon Web Services Systems Manager calls this API operation when displaying all Application Manager OpsMetadata objects or blobs.

SELECT
creation_date,
last_modified_date,
last_modified_user,
ops_metadata_arn,
resource_id
FROM aws.ssm.ops_metadatas
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_ops_metadata

If you create a new application in Application Manager, Amazon Web Services Systems Manager calls this API operation to specify information about the new application, including the application type.

INSERT INTO aws.ssm.ops_metadatas (
ResourceId,
Metadata,
Tags,
region
)
SELECT 
'{{ ResourceId }}' /* required */,
'{{ Metadata }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
ops_metadata_arn
;

Manifest

# Description fields are for documentation purposes
- name: ops_metadatas
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the ops_metadatas resource.
  - name: ResourceId
    value: "{{ ResourceId }}"
    description: |
      A resource ID for a new Application Manager application.
  - name: Metadata
    value: "{{ Metadata }}"
    description: |
      Metadata for a new Application Manager application.
  - name: Tags
    description: |
      Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target Amazon Web Services Region. In this case, you could specify the following key-value pairs: Key=Environment,Value=Production Key=Region,Value=us-east-2
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_ops_metadata

Amazon Web Services Systems Manager calls this API operation when you edit OpsMetadata in Application Manager.

UPDATE aws.ssm.ops_metadatas
SET 
OpsMetadataArn = '{{ OpsMetadataArn }}',
MetadataToUpdate = '{{ MetadataToUpdate }}',
KeysToDelete = '{{ KeysToDelete }}'
WHERE 
region = '{{ region }}' --required
AND OpsMetadataArn = '{{ OpsMetadataArn }}' --required
RETURNING
ops_metadata_arn;

DELETE examples

delete_ops_metadata

Delete OpsMetadata related to an application.

DELETE FROM aws.ssm.ops_metadatas
WHERE region = '{{ region }}' --required
;