Skip to content

Create View

resourceexplorer_create_view R Documentation

Creates a view that users can query by using the Search operation

Description

Creates a view that users can query by using the search operation. Results from queries that you make using this view include only resources that match the view's Filters. For more information about Amazon Web Services Resource Explorer views, see Managing views in the Amazon Web Services Resource Explorer User Guide.

Only the principals with an IAM identity-based policy that grants Allow to the search action on a Resource with the Amazon resource name (ARN) of this view can search using views you create with this operation.

Usage

resourceexplorer_create_view(ClientToken, Filters, IncludedProperties,
  Scope, Tags, ViewName)

Arguments

ClientToken

This value helps ensure idempotency. Resource Explorer uses this value to prevent the accidental creation of duplicate versions. We recommend that you generate a UUID-type value to ensure the uniqueness of your views.

Filters

An array of strings that specify which resources are included in the results of queries made using this view. When you use this view in a search operation, the filter string is combined with the search's QueryString parameter using a logical AND operator.

For information about the supported syntax, see Search query reference for Resource Explorer in the Amazon Web Services Resource Explorer User Guide.

This query string in the context of this operation supports only filter prefixes with optional operators. It doesn't support free-form text. For example, the string region:us* service:ec2 -tag:stage=prod includes all Amazon EC2 resources in any Amazon Web Services Region that begins with the letters us and is not tagged with a key Stage that has the value prod.

IncludedProperties

Specifies optional fields that you want included in search results from this view. It is a list of objects that each describe a field to include.

The default is an empty list, with no optional fields included in the results.

Scope

The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.

Tags

Tag key and value pairs that are attached to the view.

ViewName

[required] The name of the new view. This name appears in the list of views in Resource Explorer.

The name must be no more than 64 characters long, and can include letters, digits, and the dash (-) character. The name must be unique within its Amazon Web Services Region.

Value

A list with the following syntax: 

list(
  View = list(
    Filters = list(
      FilterString = "string"
    ),
    IncludedProperties = list(
      list(
        Name = "string"
      )
    ),
    LastUpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    Owner = "string",
    Scope = "string",
    ViewArn = "string"
  )
)

Request syntax

svc$create_view(
  ClientToken = "string",
  Filters = list(
    FilterString = "string"
  ),
  IncludedProperties = list(
    list(
      Name = "string"
    )
  ),
  Scope = "string",
  Tags = list(
    "string"
  ),
  ViewName = "string"
)