AWS.Tools.OSIS.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.OSIS</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet"> <summary> Tags an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline to tag.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet.Tag"> <summary> <para> <para>The list of key-value tags to add to the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.AddOSISResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineCmdlet"> <summary> Retrieves information about an OpenSearch Ingestion pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.GetPipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.GetPipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintCmdlet"> <summary> Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a <c>CreatePipeline</c> request. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using blueprints to create a pipeline</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintCmdlet.BlueprintName"> <summary> <para> <para>The name of the blueprint to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintCmdlet.Format"> <summary> <para> <para>The format format of the blueprint to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Blueprint'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.GetPipelineBlueprintResponse). Specifying the name of a property of type Amazon.OSIS.Model.GetPipelineBlueprintResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the BlueprintName parameter. The -PassThru parameter is deprecated, use -Select '^BlueprintName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintListCmdlet"> <summary> Retrieves a list of all available blueprints for Data Prepper. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#pipeline-blueprint">Using blueprints to create a pipeline</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineBlueprintListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Blueprints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ListPipelineBlueprintsResponse). Specifying the name of a property of type Amazon.OSIS.Model.ListPipelineBlueprintsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineChangeProgressCmdlet"> <summary> Returns progress information for the current change happening on an OpenSearch Ingestion pipeline. Currently, this operation only returns information when a pipeline is being created. <para> For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html#get-pipeline-progress">Tracking the status of pipeline creation</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineChangeProgressCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineChangeProgressCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ChangeProgressStatuses'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.GetPipelineChangeProgressResponse). Specifying the name of a property of type Amazon.OSIS.Model.GetPipelineChangeProgressResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineChangeProgressCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointConnectionListCmdlet"> <summary> Lists the pipeline endpoints connected to pipelines in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointConnectionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of pipeline endpoint connections to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointConnectionListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListPipelineEndpointConnections</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListPipelineEndpointConnections</c> operations, which returns results in the next page.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointConnectionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineEndpointConnections'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ListPipelineEndpointConnectionsResponse). Specifying the name of a property of type Amazon.OSIS.Model.ListPipelineEndpointConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointConnectionListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointListCmdlet"> <summary> Lists all pipeline endpoints in your account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of pipeline endpoints to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListPipelineEndpoints</c> operation returns a <c>NextToken</c>, you can include the returned <c>NextToken</c> in subsequent <c>ListPipelineEndpoints</c> operations, which returns results in the next page.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineEndpoints'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ListPipelineEndpointsResponse). Specifying the name of a property of type Amazon.OSIS.Model.ListPipelineEndpointsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineEndpointListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineListCmdlet"> <summary> Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html">Viewing Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineListCmdlet.MaxResult"> <summary> <para> <para>An optional parameter that specifies the maximum number of results to return. You can use <c>nextToken</c> to get the next page of results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineListCmdlet.NextToken"> <summary> <para> <para>If your initial <c>ListPipelines</c> operation returns a <c>nextToken</c>, you can include the returned <c>nextToken</c> in subsequent <c>ListPipelines</c> operations, which returns results in the next page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISPipelineListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipelines'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ListPipelinesResponse). Specifying the name of a property of type Amazon.OSIS.Model.ListPipelinesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourcePolicyCmdlet"> <summary> Retrieves the resource-based policy attached to an OpenSearch Ingestion resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.OSIS.Model.GetResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourceTagCmdlet"> <summary> Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.OSIS.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.GetOSISResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet"> <summary> Creates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html">Creating Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.VpcAttachmentOptions_AttachToVpc"> <summary> <para> <para>Whether a VPC is attached to the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.VpcAttachmentOptions_CidrBlock"> <summary> <para> <para>The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.LogPublishingOptions_IsLoggingEnabled"> <summary> <para> <para>Whether logs should be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.EncryptionAtRestOptions_KmsKeyArn"> <summary> <para> <para>The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.CloudWatchLogDestination_LogGroup"> <summary> <para> <para>The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, <c>/aws/vendedlogs/OpenSearchService/pipelines</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.MaxUnit"> <summary> <para> <para>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.MinUnit"> <summary> <para> <para>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.BufferOptions_PersistentBufferEnabled"> <summary> <para> <para>Whether persistent buffering should be enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.PipelineConfigurationBody"> <summary> <para> <para>The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with <c>\n</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.PipelineRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.VpcOptions_SecurityGroupId"> <summary> <para> <para>A list of security groups associated with the VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.VpcOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs associated with the VPC endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.Tag"> <summary> <para> <para>List of tags to add to the pipeline upon creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.VpcOptions_VpcEndpointManagement"> <summary> <para> <para>Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.CreatePipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.CreatePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet"> <summary> Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to ingest data from your VPC into pipelines that you have access to. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.PipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.VpcOptions_SecurityGroupId"> <summary> <para> <para>A list of security group IDs that control network access to the pipeline endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.VpcOptions_SubnetId"> <summary> <para> <para>A list of subnet IDs where the pipeline endpoint network interfaces are created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.CreatePipelineEndpointResponse). Specifying the name of a property of type Amazon.OSIS.Model.CreatePipelineEndpointResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.NewOSISPipelineEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineCmdlet"> <summary> Deletes an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/delete-pipeline.html">Deleting Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.DeletePipelineResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineEndpointCmdlet"> <summary> Deletes a VPC endpoint for an OpenSearch Ingestion pipeline. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineEndpointCmdlet.EndpointId"> <summary> <para> <para>The unique identifier of the pipeline endpoint to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineEndpointCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.DeletePipelineEndpointResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineEndpointCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EndpointId parameter. The -PassThru parameter is deprecated, use -Select '^EndpointId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISPipelineEndpointCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourcePolicyCmdlet"> <summary> Deletes a resource-based policy from an OpenSearch Ingestion resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource from which to delete the policy.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet"> <summary> Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/tag-pipeline.html">Tagging Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline to remove tags from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RemoveOSISResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet"> <summary> Revokes pipeline endpoints from specified endpoint IDs. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet.EndpointId"> <summary> <para> <para>A list of endpoint IDs for which to revoke access to the pipeline.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet.PipelineArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint connections.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PipelineArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.RevokePipelineEndpointConnectionsResponse). Specifying the name of a property of type Amazon.OSIS.Model.RevokePipelineEndpointConnectionsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineArn parameter. The -PassThru parameter is deprecated, use -Select '^PipelineArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.RevokeOSISPipelineEndpointConnectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.StartOSISPipelineCmdlet"> <summary> Starts an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--start">Starting an OpenSearch Ingestion pipeline</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StartOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to start.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StartOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.StartPipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.StartPipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StartOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StartOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.StopOSISPipelineCmdlet"> <summary> Stops an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline--stop-start.html#pipeline--stop">Stopping an OpenSearch Ingestion pipeline</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StopOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StopOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.StopPipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.StopPipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StopOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.StopOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet"> <summary> Updates an OpenSearch Ingestion pipeline. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/update-pipeline.html">Updating Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.LogPublishingOptions_IsLoggingEnabled"> <summary> <para> <para>Whether logs should be published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.EncryptionAtRestOptions_KmsKeyArn"> <summary> <para> <para>The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.CloudWatchLogDestination_LogGroup"> <summary> <para> <para>The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing log group or create a new one. For example, <c>/aws/vendedlogs/OpenSearchService/pipelines</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.MaxUnit"> <summary> <para> <para>The maximum pipeline capacity, in Ingestion Compute Units (ICUs)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.MinUnit"> <summary> <para> <para>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.BufferOptions_PersistentBufferEnabled"> <summary> <para> <para>Whether persistent buffering should be enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.PipelineConfigurationBody"> <summary> <para> <para>The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with <c>\n</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.PipelineName"> <summary> <para> <para>The name of the pipeline to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.PipelineRoleArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Pipeline'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.UpdatePipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.UpdatePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineName parameter. The -PassThru parameter is deprecated, use -Select '^PipelineName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UpdateOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.UseOSISPipelineCmdlet"> <summary> Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/creating-pipeline.html">Creating Amazon OpenSearch Ingestion pipelines</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UseOSISPipelineCmdlet.PipelineConfigurationBody"> <summary> <para> <para>The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with <c>\n</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UseOSISPipelineCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.ValidatePipelineResponse). Specifying the name of a property of type Amazon.OSIS.Model.ValidatePipelineResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UseOSISPipelineCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PipelineConfigurationBody parameter. The -PassThru parameter is deprecated, use -Select '^PipelineConfigurationBody' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.UseOSISPipelineCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet"> <summary> Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based policies grant permissions to principals to perform actions on the resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet.Policy"> <summary> <para> <para>The resource-based policy document in JSON format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource to attach the policy to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.OSIS.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.OSIS.Model.PutResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.OSIS.WriteOSISResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |