| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ResourceExplorer2.CreateView
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.
Synopsis
- data CreateView = CreateView' {
- clientToken :: Maybe Text
- filters :: Maybe (Sensitive SearchFilter)
- includedProperties :: Maybe [IncludedProperty]
- tags :: Maybe (HashMap Text Text)
- viewName :: Text
- newCreateView :: Text -> CreateView
- createView_clientToken :: Lens' CreateView (Maybe Text)
- createView_filters :: Lens' CreateView (Maybe SearchFilter)
- createView_includedProperties :: Lens' CreateView (Maybe [IncludedProperty])
- createView_tags :: Lens' CreateView (Maybe (HashMap Text Text))
- createView_viewName :: Lens' CreateView Text
- data CreateViewResponse = CreateViewResponse' {
- view :: Maybe View
- httpStatus :: Int
- newCreateViewResponse :: Int -> CreateViewResponse
- createViewResponse_view :: Lens' CreateViewResponse (Maybe View)
- createViewResponse_httpStatus :: Lens' CreateViewResponse Int
Creating a Request
data CreateView Source #
See: newCreateView smart constructor.
Constructors
| CreateView' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> CreateView |
Create a value of CreateView with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateView', createView_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.
CreateView, createView_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.
CreateView, createView_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.
$sel:tags:CreateView', createView_tags - Tag key and value pairs that are attached to the view.
$sel:viewName:CreateView', createView_viewName - 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.
Request Lenses
createView_clientToken :: Lens' CreateView (Maybe Text) Source #
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.
createView_filters :: Lens' CreateView (Maybe SearchFilter) Source #
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.
createView_includedProperties :: Lens' CreateView (Maybe [IncludedProperty]) Source #
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.
createView_tags :: Lens' CreateView (Maybe (HashMap Text Text)) Source #
Tag key and value pairs that are attached to the view.
createView_viewName :: Lens' CreateView Text Source #
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.
Destructuring the Response
data CreateViewResponse Source #
See: newCreateViewResponse smart constructor.
Constructors
| CreateViewResponse' | |
Fields
| |
Instances
newCreateViewResponse Source #
Arguments
| :: Int | |
| -> CreateViewResponse |
Create a value of CreateViewResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:view:CreateViewResponse', createViewResponse_view - A structure that contains the details about the new view.
$sel:httpStatus:CreateViewResponse', createViewResponse_httpStatus - The response's http status code.
Response Lenses
createViewResponse_view :: Lens' CreateViewResponse (Maybe View) Source #
A structure that contains the details about the new view.
createViewResponse_httpStatus :: Lens' CreateViewResponse Int Source #
The response's http status code.