{ "smithy": "2.0", "metadata": { "suppressions": [ { "id": "HttpMethodSemantics", "namespace": "*" }, { "id": "HttpResponseCodeSemantics", "namespace": "*" }, { "id": "PaginatedTrait", "namespace": "*" }, { "id": "HttpHeaderTrait", "namespace": "*" }, { "id": "HttpUriConflict", "namespace": "*" }, { "id": "Service", "namespace": "*" } ] }, "shapes": { "com.amazonaws.osis#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "
You don't have permissions to access the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.osis#AmazonOpenSearchIngestionService": { "type": "service", "version": "2022-01-01", "operations": [ { "target": "com.amazonaws.osis#CreatePipeline" }, { "target": "com.amazonaws.osis#CreatePipelineEndpoint" }, { "target": "com.amazonaws.osis#DeletePipeline" }, { "target": "com.amazonaws.osis#DeletePipelineEndpoint" }, { "target": "com.amazonaws.osis#DeleteResourcePolicy" }, { "target": "com.amazonaws.osis#GetPipeline" }, { "target": "com.amazonaws.osis#GetPipelineBlueprint" }, { "target": "com.amazonaws.osis#GetPipelineChangeProgress" }, { "target": "com.amazonaws.osis#GetResourcePolicy" }, { "target": "com.amazonaws.osis#ListPipelineBlueprints" }, { "target": "com.amazonaws.osis#ListPipelineEndpointConnections" }, { "target": "com.amazonaws.osis#ListPipelineEndpoints" }, { "target": "com.amazonaws.osis#ListPipelines" }, { "target": "com.amazonaws.osis#ListTagsForResource" }, { "target": "com.amazonaws.osis#PutResourcePolicy" }, { "target": "com.amazonaws.osis#RevokePipelineEndpointConnections" }, { "target": "com.amazonaws.osis#StartPipeline" }, { "target": "com.amazonaws.osis#StopPipeline" }, { "target": "com.amazonaws.osis#TagResource" }, { "target": "com.amazonaws.osis#UntagResource" }, { "target": "com.amazonaws.osis#UpdatePipeline" }, { "target": "com.amazonaws.osis#ValidatePipeline" } ], "traits": { "aws.api#service": { "sdkId": "OSIS", "arnNamespace": "osis", "cloudFormationName": "OSIS", "cloudTrailEventSource": "osis.amazonaws.com", "endpointPrefix": "osis" }, "aws.auth#sigv4": { "name": "osis" }, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a \n fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see\n Getting data into your cluster using OpenSearch Ingestion.
", "smithy.api#title": "Amazon OpenSearch Ingestion", "smithy.api#xmlNamespace": { "uri": "http://osis.amazonaws.com/doc/2022-01-01" }, "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://osis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://osis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://osis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://osis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://osis-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://osis-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://osis.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://osis.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://osis.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://osis.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.osis#AwsAccountId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^\\\\d{12}$" } }, "com.amazonaws.osis#BlueprintFormat": { "type": "string", "traits": { "smithy.api#pattern": "^(YAML|JSON)$" } }, "com.amazonaws.osis#Boolean": { "type": "boolean" }, "com.amazonaws.osis#BufferOptions": { "type": "structure", "members": { "PersistentBufferEnabled": { "target": "com.amazonaws.osis#Boolean", "traits": { "smithy.api#documentation": "Whether persistent buffering should be enabled.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Options that specify the configuration of a persistent buffer.\n To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.
The name of the stage.
" } }, "Status": { "target": "com.amazonaws.osis#ChangeProgressStageStatuses", "traits": { "smithy.api#documentation": "The current status of the stage that the change is in.
" } }, "Description": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "A description of the stage.
" } }, "LastUpdatedAt": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The most recent updated timestamp of the stage.
" } } }, "traits": { "smithy.api#documentation": "Progress details for a specific stage of a pipeline configuration change.
" } }, "com.amazonaws.osis#ChangeProgressStageList": { "type": "list", "member": { "target": "com.amazonaws.osis#ChangeProgressStage" } }, "com.amazonaws.osis#ChangeProgressStageStatuses": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.osis#ChangeProgressStatus": { "type": "structure", "members": { "StartTime": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The time at which the configuration change is made on the pipeline.
" } }, "Status": { "target": "com.amazonaws.osis#ChangeProgressStatuses", "traits": { "smithy.api#documentation": "The overall status of the pipeline configuration change.
" } }, "TotalNumberOfStages": { "target": "com.amazonaws.osis#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The total number of stages required for the pipeline configuration change.
" } }, "ChangeProgressStages": { "target": "com.amazonaws.osis#ChangeProgressStageList", "traits": { "smithy.api#documentation": "Information about the stages that the pipeline is going through to perform the configuration change.
" } } }, "traits": { "smithy.api#documentation": "The progress details of a pipeline configuration change.
" } }, "com.amazonaws.osis#ChangeProgressStatusList": { "type": "list", "member": { "target": "com.amazonaws.osis#ChangeProgressStatus" } }, "com.amazonaws.osis#ChangeProgressStatuses": { "type": "enum", "members": { "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.osis#CidrBlock": { "type": "string", "traits": { "smithy.api#pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/24$" } }, "com.amazonaws.osis#CloudWatchLogDestination": { "type": "structure", "members": { "LogGroup": { "target": "com.amazonaws.osis#LogGroup", "traits": { "smithy.api#documentation": "The name of the CloudWatch Logs group to send pipeline logs to. You can specify an existing\n log group or create a new one. For example,\n /aws/vendedlogs/OpenSearchService/pipelines.
The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
" } }, "com.amazonaws.osis#ConflictException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The client attempted to remove a resource that is currently in use.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.osis#CreatePipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#CreatePipelineRequest" }, "output": { "target": "com.amazonaws.osis#CreatePipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceAlreadyExistsException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/createPipeline", "code": 200 } } }, "com.amazonaws.osis#CreatePipelineEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.osis#CreatePipelineEndpointRequest" }, "output": { "target": "com.amazonaws.osis#CreatePipelineEndpointResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a VPC endpoint for an OpenSearch Ingestion pipeline. Pipeline endpoints allow you to\n ingest data from your VPC into pipelines that you have access to.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/createPipelineEndpoint", "code": 200 } } }, "com.amazonaws.osis#CreatePipelineEndpointRequest": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to create the endpoint for.
", "smithy.api#required": {} } }, "VpcOptions": { "target": "com.amazonaws.osis#PipelineEndpointVpcOptions", "traits": { "smithy.api#documentation": "Container for the VPC configuration for the pipeline endpoint, including subnet IDs and\n security group IDs.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#CreatePipelineEndpointResponse": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline associated with the endpoint.
" } }, "EndpointId": { "target": "com.amazonaws.osis#PipelineEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the pipeline endpoint.
" } }, "Status": { "target": "com.amazonaws.osis#PipelineEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline endpoint.
" } }, "VpcId": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The ID of the VPC where the pipeline endpoint was created.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#CreatePipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the\n pipelines owned by an account within an Amazon Web Services Region.
", "smithy.api#required": {} } }, "MinUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
", "smithy.api#required": {} } }, "MaxUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
", "smithy.api#required": {} } }, "PipelineConfigurationBody": { "target": "com.amazonaws.osis#PipelineConfigurationBody", "traits": { "smithy.api#documentation": "The pipeline configuration in YAML format. The command accepts the pipeline configuration as\n a string or within a .yaml file. If you provide the configuration as a string, each new line must\n be escaped with \\n.
Key-value pairs to configure log publishing.
" } }, "VpcOptions": { "target": "com.amazonaws.osis#VpcOptions", "traits": { "smithy.api#documentation": "Container for the values required to configure VPC access for the pipeline. If you don't\n specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
" } }, "BufferOptions": { "target": "com.amazonaws.osis#BufferOptions", "traits": { "smithy.api#documentation": "Key-value pairs to configure persistent buffering for the pipeline.
" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.osis#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "Key-value pairs to configure encryption for data that is written to a persistent\n buffer.
" } }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { "smithy.api#documentation": "List of tags to add to the pipeline upon creation.
" } }, "PipelineRoleArn": { "target": "com.amazonaws.osis#PipelineRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access\n Amazon Web Services resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#CreatePipelineResponse": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.osis#Pipeline", "traits": { "smithy.api#documentation": "Container for information about the created pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#DeletePipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#DeletePipelineRequest" }, "output": { "target": "com.amazonaws.osis#DeletePipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#ConflictException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "DELETE", "uri": "/2022-01-01/osis/deletePipeline/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#DeletePipelineEndpoint": { "type": "operation", "input": { "target": "com.amazonaws.osis#DeletePipelineEndpointRequest" }, "output": { "target": "com.amazonaws.osis#DeletePipelineEndpointResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "DELETE", "uri": "/2022-01-01/osis/deletePipelineEndpoint/{EndpointId}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.osis#DeletePipelineEndpointRequest": { "type": "structure", "members": { "EndpointId": { "target": "com.amazonaws.osis#PipelineEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the pipeline endpoint to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#DeletePipelineEndpointResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#DeletePipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#DeletePipelineResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#DeleteResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.osis#DeleteResourcePolicyRequest" }, "output": { "target": "com.amazonaws.osis#DeleteResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a resource-based policy from an OpenSearch Ingestion resource.
", "smithy.api#http": { "method": "DELETE", "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.osis#DeleteResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to delete the policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#DeleteResourcePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#DisabledOperationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "Exception is thrown when an operation has been disabled.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.osis#EncryptionAtRestOptions": { "type": "structure", "members": { "KmsKeyArn": { "target": "com.amazonaws.osis#KmsKeyArn", "traits": { "smithy.api#documentation": "The ARN of the KMS key used to encrypt buffer data.\n By default, data is encrypted using an Amazon Web Services owned key.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Options to control how OpenSearch encrypts buffer data.
" } }, "com.amazonaws.osis#ErrorMessage": { "type": "string" }, "com.amazonaws.osis#GetPipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#GetPipelineRequest" }, "output": { "target": "com.amazonaws.osis#GetPipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/getPipeline/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#GetPipelineBlueprint": { "type": "operation", "input": { "target": "com.amazonaws.osis#GetPipelineBlueprintRequest" }, "output": { "target": "com.amazonaws.osis#GetPipelineBlueprintResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are\n templates for the configuration needed for a CreatePipeline request. For more\n information, see Using\n blueprints to create a pipeline.
The name of the blueprint to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Format": { "target": "com.amazonaws.osis#BlueprintFormat", "traits": { "smithy.api#documentation": "The format format of the blueprint to retrieve.
", "smithy.api#httpQuery": "format" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#GetPipelineBlueprintResponse": { "type": "structure", "members": { "Blueprint": { "target": "com.amazonaws.osis#PipelineBlueprint", "traits": { "smithy.api#documentation": "The requested blueprint in YAML format.
" } }, "Format": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The format of the blueprint.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#GetPipelineChangeProgress": { "type": "operation", "input": { "target": "com.amazonaws.osis#GetPipelineChangeProgressRequest" }, "output": { "target": "com.amazonaws.osis#GetPipelineChangeProgressResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns progress information for the current change happening on an OpenSearch Ingestion\n pipeline. Currently, this operation only returns information when a pipeline is being\n created.
\nFor more information, see Tracking the status of pipeline creation.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/getPipelineChangeProgress/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#GetPipelineChangeProgressRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#GetPipelineChangeProgressResponse": { "type": "structure", "members": { "ChangeProgressStatuses": { "target": "com.amazonaws.osis#ChangeProgressStatusList", "traits": { "smithy.api#documentation": "The current status of the change happening on the pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#GetPipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#GetPipelineResponse": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.osis#Pipeline", "traits": { "smithy.api#documentation": "Detailed information about the requested pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#GetResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.osis#GetResourcePolicyRequest" }, "output": { "target": "com.amazonaws.osis#GetResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", "code": 200 } } }, "com.amazonaws.osis#GetResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which to retrieve the policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#GetResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, "Policy": { "target": "com.amazonaws.osis#ResourcePolicy", "traits": { "smithy.api#documentation": "The resource-based policy document in JSON format.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#IngestEndpointUrlsList": { "type": "list", "member": { "target": "com.amazonaws.osis#String" } }, "com.amazonaws.osis#Integer": { "type": "integer", "traits": { "smithy.api#default": 0 } }, "com.amazonaws.osis#InternalException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request failed because of an unknown error, exception, or failure (the failure is\n internal to the service).
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.osis#InvalidPaginationTokenException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An invalid pagination token provided in the request.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.osis#KmsKeyArn": { "type": "string", "traits": { "smithy.api#length": { "min": 7, "max": 2048 } } }, "com.amazonaws.osis#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You attempted to create more than the allowed number of tags.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.osis#ListPipelineBlueprints": { "type": "operation", "input": { "target": "com.amazonaws.osis#ListPipelineBlueprintsRequest" }, "output": { "target": "com.amazonaws.osis#ListPipelineBlueprintsResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#InvalidPaginationTokenException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves a list of all available blueprints for Data Prepper. For more information, see\n Using\n blueprints to create a pipeline.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/listPipelineBlueprints", "code": 200 } } }, "com.amazonaws.osis#ListPipelineBlueprintsRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#ListPipelineBlueprintsResponse": { "type": "structure", "members": { "Blueprints": { "target": "com.amazonaws.osis#PipelineBlueprintsSummaryList", "traits": { "smithy.api#documentation": "A list of available blueprints for Data Prepper.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ListPipelineEndpointConnections": { "type": "operation", "input": { "target": "com.amazonaws.osis#ListPipelineEndpointConnectionsRequest" }, "output": { "target": "com.amazonaws.osis#ListPipelineEndpointConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the pipeline endpoints connected to pipelines in your account.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listPipelineEndpointConnections", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "PipelineEndpointConnections", "pageSize": "MaxResults" } } }, "com.amazonaws.osis#ListPipelineEndpointConnectionsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.osis#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of pipeline endpoint connections to return in the response.
", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.osis#NextToken", "traits": { "smithy.api#documentation": "If your initial ListPipelineEndpointConnections operation returns a\n nextToken, you can include the returned nextToken in subsequent\n ListPipelineEndpointConnections operations, which returns results in the next\n page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
A list of pipeline endpoint connections.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ListPipelineEndpoints": { "type": "operation", "input": { "target": "com.amazonaws.osis#ListPipelineEndpointsRequest" }, "output": { "target": "com.amazonaws.osis#ListPipelineEndpointsResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all pipeline endpoints in your account.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listPipelineEndpoints", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "PipelineEndpoints", "pageSize": "MaxResults" } } }, "com.amazonaws.osis#ListPipelineEndpointsRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.osis#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of pipeline endpoints to return in the response.
", "smithy.api#httpQuery": "maxResults" } }, "NextToken": { "target": "com.amazonaws.osis#NextToken", "traits": { "smithy.api#documentation": "If your initial ListPipelineEndpoints operation returns a\n NextToken, you can include the returned NextToken in subsequent\n ListPipelineEndpoints operations, which returns results in the next page.
When NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
A list of pipeline endpoints.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ListPipelines": { "type": "operation", "input": { "target": "com.amazonaws.osis#ListPipelinesRequest" }, "output": { "target": "com.amazonaws.osis#ListPipelinesResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#InvalidPaginationTokenException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region.\n For more information, see Viewing Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listPipelines", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.osis#ListPipelinesRequest": { "type": "structure", "members": { "MaxResults": { "target": "com.amazonaws.osis#MaxResults", "traits": { "smithy.api#documentation": "An optional parameter that specifies the maximum number of results to return. You can use\n nextToken to get the next page of results.
If your initial ListPipelines operation returns a nextToken, you\n can include the returned nextToken in subsequent ListPipelines\n operations, which returns results in the next page.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
A list of all existing Data Prepper pipelines.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.osis#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.osis#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information,\n see Tagging Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "GET", "uri": "/2022-01-01/osis/listTagsForResource", "code": 200 } } }, "com.amazonaws.osis#ListTagsForResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to retrieve tags for.
", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { "smithy.api#documentation": "A list of tags associated with the given pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#LogGroup": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 }, "smithy.api#pattern": "^\\/aws\\/vendedlogs\\/[\\.\\-_/#A-Za-z0-9]+$" } }, "com.amazonaws.osis#LogPublishingOptions": { "type": "structure", "members": { "IsLoggingEnabled": { "target": "com.amazonaws.osis#Boolean", "traits": { "smithy.api#documentation": "Whether logs should be published.
" } }, "CloudWatchLogDestination": { "target": "com.amazonaws.osis#CloudWatchLogDestination", "traits": { "smithy.api#documentation": "The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This\n parameter is required if IsLoggingEnabled is set to true.
Container for the values required to configure logging for the pipeline. If you don't\n specify these values, OpenSearch Ingestion will not publish logs from your application to\n CloudWatch Logs.
" } }, "com.amazonaws.osis#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.osis#NextToken": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 3000 }, "smithy.api#pattern": "^([\\s\\S]*)$" } }, "com.amazonaws.osis#Pipeline": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the pipeline.
" } }, "PipelineArn": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" } }, "MinUnits": { "target": "com.amazonaws.osis#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" } }, "MaxUnits": { "target": "com.amazonaws.osis#Integer", "traits": { "smithy.api#default": 0, "smithy.api#documentation": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
" } }, "Status": { "target": "com.amazonaws.osis#PipelineStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline.
" } }, "StatusReason": { "target": "com.amazonaws.osis#PipelineStatusReason", "traits": { "smithy.api#documentation": "The reason for the current status of the pipeline.
" } }, "PipelineConfigurationBody": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The Data Prepper pipeline configuration in YAML format.
" } }, "CreatedAt": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the pipeline was created.
" } }, "LastUpdatedAt": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the pipeline was last updated.
" } }, "IngestEndpointUrls": { "target": "com.amazonaws.osis#IngestEndpointUrlsList", "traits": { "smithy.api#documentation": "The ingestion endpoints for the pipeline, which you can send data to.
" } }, "LogPublishingOptions": { "target": "com.amazonaws.osis#LogPublishingOptions", "traits": { "smithy.api#documentation": "Key-value pairs that represent log publishing settings.
" } }, "VpcEndpoints": { "target": "com.amazonaws.osis#VpcEndpointsList", "traits": { "smithy.api#documentation": "The VPC interface endpoints that have access to the pipeline.
" } }, "BufferOptions": { "target": "com.amazonaws.osis#BufferOptions" }, "EncryptionAtRestOptions": { "target": "com.amazonaws.osis#EncryptionAtRestOptions" }, "VpcEndpointService": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The VPC endpoint service name for the pipeline.
" } }, "ServiceVpcEndpoints": { "target": "com.amazonaws.osis#ServiceVpcEndpointsList", "traits": { "smithy.api#documentation": "A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
" } }, "Destinations": { "target": "com.amazonaws.osis#PipelineDestinationList", "traits": { "smithy.api#documentation": "Destinations to which the pipeline writes data.
" } }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { "smithy.api#documentation": "A list of tags associated with the given pipeline.
" } }, "PipelineRoleArn": { "target": "com.amazonaws.osis#PipelineRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS\n resources.
" } } }, "traits": { "smithy.api#documentation": "Information about an existing OpenSearch Ingestion pipeline.
" } }, "com.amazonaws.osis#PipelineArn": { "type": "string", "traits": { "smithy.api#length": { "min": 46, "max": 76 }, "smithy.api#pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b):osis:.+:pipeline\\/.+$" } }, "com.amazonaws.osis#PipelineBlueprint": { "type": "structure", "members": { "BlueprintName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the blueprint.
" } }, "PipelineConfigurationBody": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The YAML configuration of the blueprint.
" } }, "DisplayName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The display name of the blueprint.
" } }, "DisplayDescription": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "A description of the blueprint.
" } }, "Service": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the service that the blueprint is associated with.
" } }, "UseCase": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The use case that the blueprint relates to.
" } } }, "traits": { "smithy.api#documentation": "Container for information about an OpenSearch Ingestion blueprint.
" } }, "com.amazonaws.osis#PipelineBlueprintSummary": { "type": "structure", "members": { "BlueprintName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the blueprint.
" } }, "DisplayName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The display name of the blueprint.
" } }, "DisplayDescription": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "A description of the blueprint.
" } }, "Service": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the service that the blueprint is associated with.
" } }, "UseCase": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The use case that the blueprint relates to.
" } } }, "traits": { "smithy.api#documentation": "A summary of an OpenSearch Ingestion blueprint.
" } }, "com.amazonaws.osis#PipelineBlueprintsSummaryList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineBlueprintSummary" } }, "com.amazonaws.osis#PipelineConfigurationBody": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100000 } } }, "com.amazonaws.osis#PipelineDestination": { "type": "structure", "members": { "ServiceName": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The name of the service receiving data from the pipeline.
" } }, "Endpoint": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The endpoint receiving data from the pipeline.
" } } }, "traits": { "smithy.api#documentation": "An object representing the destination of a pipeline.
" } }, "com.amazonaws.osis#PipelineDestinationList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineDestination" } }, "com.amazonaws.osis#PipelineEndpoint": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.
" } }, "EndpointId": { "target": "com.amazonaws.osis#PipelineEndpointId", "traits": { "smithy.api#documentation": "The unique identifier for the pipeline endpoint.
" } }, "Status": { "target": "com.amazonaws.osis#PipelineEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline endpoint.
" } }, "VpcId": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The ID of the VPC where the pipeline endpoint is created.
" } }, "VpcOptions": { "target": "com.amazonaws.osis#PipelineEndpointVpcOptions", "traits": { "smithy.api#documentation": "Configuration options for the VPC endpoint, including subnet and security group\n settings.
" } }, "IngestEndpointUrl": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The URL used to ingest data to the pipeline through the VPC endpoint.
" } } }, "traits": { "smithy.api#documentation": "Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private\n connectivity between your VPC and the pipeline.
" } }, "com.amazonaws.osis#PipelineEndpointConnection": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline in the endpoint connection.
" } }, "EndpointId": { "target": "com.amazonaws.osis#PipelineEndpointId", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint in the connection.
" } }, "Status": { "target": "com.amazonaws.osis#PipelineEndpointStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline endpoint connection.
" } }, "VpcEndpointOwner": { "target": "com.amazonaws.osis#AwsAccountId", "traits": { "smithy.api#documentation": "The Amazon Web Services account ID that owns the VPC endpoint used in this connection.
" } } }, "traits": { "smithy.api#documentation": "Represents a connection to a pipeline endpoint, containing details about the endpoint\n association.
" } }, "com.amazonaws.osis#PipelineEndpointConnectionsSummaryList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineEndpointConnection" } }, "com.amazonaws.osis#PipelineEndpointId": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 512 }, "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]+$" } }, "com.amazonaws.osis#PipelineEndpointIdsList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineEndpointId" } }, "com.amazonaws.osis#PipelineEndpointStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "REVOKING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKING" } }, "REVOKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKED" } } } }, "com.amazonaws.osis#PipelineEndpointVpcOptions": { "type": "structure", "members": { "SubnetIds": { "target": "com.amazonaws.osis#SubnetIds", "traits": { "smithy.api#documentation": "A list of subnet IDs where the pipeline endpoint network interfaces are created.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.osis#SecurityGroupIds", "traits": { "smithy.api#documentation": "A list of security group IDs that control network access to the pipeline endpoint.
" } } }, "traits": { "smithy.api#documentation": "Configuration settings for the VPC endpoint, specifying network access controls.
" } }, "com.amazonaws.osis#PipelineEndpointsSummaryList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineEndpoint" } }, "com.amazonaws.osis#PipelineName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 28 }, "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$" } }, "com.amazonaws.osis#PipelineRoleArn": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 2048 }, "smithy.api#pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b|aws\\-iso\\-e|aws\\-iso\\-f):iam::[0-9]+:role\\/.*$" } }, "com.amazonaws.osis#PipelineStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATING" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATING" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "UPDATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_FAILED" } }, "STARTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STARTING" } }, "START_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "START_FAILED" } }, "STOPPING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPING" } }, "STOPPED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "STOPPED" } } } }, "com.amazonaws.osis#PipelineStatusReason": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "A description of why a pipeline has a certain status.
" } } }, "traits": { "smithy.api#documentation": "Information about a pipeline's current status.
" } }, "com.amazonaws.osis#PipelineSummary": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.osis#PipelineStatus", "traits": { "smithy.api#documentation": "The current status of the pipeline.
" } }, "StatusReason": { "target": "com.amazonaws.osis#PipelineStatusReason" }, "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline.
" } }, "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline.
" } }, "MinUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" } }, "MaxUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
" } }, "CreatedAt": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the pipeline was created.
" } }, "LastUpdatedAt": { "target": "com.amazonaws.osis#Timestamp", "traits": { "smithy.api#documentation": "The date and time when the pipeline was last updated.
" } }, "Destinations": { "target": "com.amazonaws.osis#PipelineDestinationList", "traits": { "smithy.api#documentation": "A list of destinations to which the pipeline writes data.
" } }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { "smithy.api#documentation": "A list of tags associated with the given pipeline.
" } } }, "traits": { "smithy.api#documentation": "Summary information for an OpenSearch Ingestion pipeline.
" } }, "com.amazonaws.osis#PipelineSummaryList": { "type": "list", "member": { "target": "com.amazonaws.osis#PipelineSummary" } }, "com.amazonaws.osis#PipelineUnits": { "type": "integer", "traits": { "smithy.api#range": { "min": 1 } } }, "com.amazonaws.osis#PutResourcePolicy": { "type": "operation", "input": { "target": "com.amazonaws.osis#PutResourcePolicyRequest" }, "output": { "target": "com.amazonaws.osis#PutResourcePolicyResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Attaches a resource-based policy to an OpenSearch Ingestion resource. Resource-based\n policies grant permissions to principals to perform actions on the resource.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/resourcePolicy/{ResourceArn}", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.osis#PutResourcePolicyRequest": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to attach the policy to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Policy": { "target": "com.amazonaws.osis#ResourcePolicy", "traits": { "smithy.api#documentation": "The resource-based policy document in JSON format.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#PutResourcePolicyResponse": { "type": "structure", "members": { "ResourceArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, "Policy": { "target": "com.amazonaws.osis#ResourcePolicy", "traits": { "smithy.api#documentation": "The resource-based policy document that was attached to the resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ResourceAlreadyExistsException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You attempted to create a resource that already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.osis#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "You attempted to access or delete a resource that does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.osis#ResourcePolicy": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 204800 } } }, "com.amazonaws.osis#RevokePipelineEndpointConnections": { "type": "operation", "input": { "target": "com.amazonaws.osis#RevokePipelineEndpointConnectionsRequest" }, "output": { "target": "com.amazonaws.osis#RevokePipelineEndpointConnectionsResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Revokes pipeline endpoints from specified endpoint IDs.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/revokePipelineEndpointConnections", "code": 200 }, "smithy.api#idempotent": {} } }, "com.amazonaws.osis#RevokePipelineEndpointConnectionsRequest": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline from which to revoke endpoint\n connections.
", "smithy.api#required": {} } }, "EndpointIds": { "target": "com.amazonaws.osis#PipelineEndpointIdsList", "traits": { "smithy.api#documentation": "A list of endpoint IDs for which to revoke access to the pipeline.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#RevokePipelineEndpointConnectionsResponse": { "type": "structure", "members": { "PipelineArn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline from which endpoint connections were\n revoked.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 11, "max": 20 }, "smithy.api#pattern": "^sg-\\w{8}(\\w{9})?$" } }, "com.amazonaws.osis#SecurityGroupIds": { "type": "list", "member": { "target": "com.amazonaws.osis#SecurityGroupId" }, "traits": { "smithy.api#length": { "min": 1, "max": 12 } } }, "com.amazonaws.osis#ServiceVpcEndpoint": { "type": "structure", "members": { "ServiceName": { "target": "com.amazonaws.osis#VpcEndpointServiceName", "traits": { "smithy.api#documentation": "The name of the service for which a VPC endpoint was created.
" } }, "VpcEndpointId": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The unique identifier of the VPC endpoint that was created.
" } } }, "traits": { "smithy.api#documentation": "A container for information about VPC endpoints that were created to other services
" } }, "com.amazonaws.osis#ServiceVpcEndpointsList": { "type": "list", "member": { "target": "com.amazonaws.osis#ServiceVpcEndpoint" } }, "com.amazonaws.osis#StartPipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#StartPipelineRequest" }, "output": { "target": "com.amazonaws.osis#StartPipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#ConflictException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/startPipeline/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#StartPipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline to start.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#StartPipelineResponse": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.osis#Pipeline" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#StopPipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#StopPipelineRequest" }, "output": { "target": "com.amazonaws.osis#StopPipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#ConflictException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Stops an OpenSearch Ingestion pipeline. For more information, see Stopping\n an OpenSearch Ingestion pipeline.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/stopPipeline/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#StopPipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline to stop.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#StopPipelineResponse": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.osis#Pipeline" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#String": { "type": "string" }, "com.amazonaws.osis#StringList": { "type": "list", "member": { "target": "com.amazonaws.osis#String" } }, "com.amazonaws.osis#SubnetId": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 24 }, "smithy.api#pattern": "^subnet-\\w{8}(\\w{9})?$" } }, "com.amazonaws.osis#SubnetIds": { "type": "list", "member": { "target": "com.amazonaws.osis#SubnetId" }, "traits": { "smithy.api#length": { "min": 1, "max": 12 } } }, "com.amazonaws.osis#Tag": { "type": "structure", "members": { "Key": { "target": "com.amazonaws.osis#TagKey", "traits": { "smithy.api#documentation": "The tag key. Tag keys must be unique for the pipeline to which they are attached.
", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.osis#TagValue", "traits": { "smithy.api#documentation": "The value assigned to the corresponding tag key. Tag values can be null and don't have to\n be unique in a tag set. For example, you can have a key value pair in a tag set of\n project : Trinity and cost-center : Trinity\n
A tag (key-value pair) for an OpenSearch Ingestion pipeline.
" } }, "com.amazonaws.osis#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.osis#TagList": { "type": "list", "member": { "target": "com.amazonaws.osis#Tag" } }, "com.amazonaws.osis#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.osis#TagResourceRequest" }, "output": { "target": "com.amazonaws.osis#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#LimitExceededException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/tagResource", "code": 200 } } }, "com.amazonaws.osis#TagResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to tag.
", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.osis#TagList", "traits": { "smithy.api#documentation": "The list of key-value tags to add to the pipeline.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": ".*" } }, "com.amazonaws.osis#Timestamp": { "type": "timestamp" }, "com.amazonaws.osis#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.osis#UntagResourceRequest" }, "output": { "target": "com.amazonaws.osis#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging\n Amazon OpenSearch Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/untagResource", "code": 200 } } }, "com.amazonaws.osis#UntagResourceRequest": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.osis#PipelineArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pipeline to remove tags from.
", "smithy.api#httpQuery": "arn", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.osis#StringList", "traits": { "smithy.api#documentation": "The tag keys to remove.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#UpdatePipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#UpdatePipelineRequest" }, "output": { "target": "com.amazonaws.osis#UpdatePipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#ConflictException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ResourceNotFoundException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "PUT", "uri": "/2022-01-01/osis/updatePipeline/{PipelineName}", "code": 200 } } }, "com.amazonaws.osis#UpdatePipelineRequest": { "type": "structure", "members": { "PipelineName": { "target": "com.amazonaws.osis#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MinUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
" } }, "MaxUnits": { "target": "com.amazonaws.osis#PipelineUnits", "traits": { "smithy.api#documentation": "The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
" } }, "PipelineConfigurationBody": { "target": "com.amazonaws.osis#PipelineConfigurationBody", "traits": { "smithy.api#documentation": "The pipeline configuration in YAML format. The command accepts the pipeline configuration as\n a string or within a .yaml file. If you provide the configuration as a string, each new line must\n be escaped with \\n.
Key-value pairs to configure log publishing.
" } }, "BufferOptions": { "target": "com.amazonaws.osis#BufferOptions", "traits": { "smithy.api#documentation": "Key-value pairs to configure persistent buffering for the pipeline.
" } }, "EncryptionAtRestOptions": { "target": "com.amazonaws.osis#EncryptionAtRestOptions", "traits": { "smithy.api#documentation": "Key-value pairs to configure encryption for data that is written to a persistent\n buffer.
" } }, "PipelineRoleArn": { "target": "com.amazonaws.osis#PipelineRoleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access\n Amazon Web Services resources.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.osis#UpdatePipelineResponse": { "type": "structure", "members": { "Pipeline": { "target": "com.amazonaws.osis#Pipeline", "traits": { "smithy.api#documentation": "Container for information about the updated pipeline.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ValidatePipeline": { "type": "operation", "input": { "target": "com.amazonaws.osis#ValidatePipelineRequest" }, "output": { "target": "com.amazonaws.osis#ValidatePipelineResponse" }, "errors": [ { "target": "com.amazonaws.osis#AccessDeniedException" }, { "target": "com.amazonaws.osis#DisabledOperationException" }, { "target": "com.amazonaws.osis#InternalException" }, { "target": "com.amazonaws.osis#ValidationException" } ], "traits": { "smithy.api#documentation": "Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For\n more information, see Creating Amazon OpenSearch\n Ingestion pipelines.
", "smithy.api#http": { "method": "POST", "uri": "/2022-01-01/osis/validatePipeline", "code": 200 } } }, "com.amazonaws.osis#ValidatePipelineRequest": { "type": "structure", "members": { "PipelineConfigurationBody": { "target": "com.amazonaws.osis#PipelineConfigurationBody", "traits": { "smithy.api#documentation": "The pipeline configuration in YAML format. The command accepts the pipeline configuration as\n a string or within a .yaml file. If you provide the configuration as a string, each new line must\n be escaped with \\n.
A boolean indicating whether or not the pipeline configuration is valid.
" } }, "Errors": { "target": "com.amazonaws.osis#ValidationMessageList", "traits": { "smithy.api#documentation": "A list of errors if the configuration is invalid.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.osis#ValidationException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.osis#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An exception for missing or invalid input fields.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.osis#ValidationMessage": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The validation message.
" } } }, "traits": { "smithy.api#documentation": "A validation message associated with a ValidatePipeline request in OpenSearch\n Ingestion.
Whether a VPC is attached to the pipeline.
", "smithy.api#required": {} } }, "CidrBlock": { "target": "com.amazonaws.osis#CidrBlock", "traits": { "smithy.api#documentation": "The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs).
" } } }, "traits": { "smithy.api#documentation": "Options for attaching a VPC to pipeline.
" } }, "com.amazonaws.osis#VpcEndpoint": { "type": "structure", "members": { "VpcEndpointId": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The unique identifier of the endpoint.
" } }, "VpcId": { "target": "com.amazonaws.osis#String", "traits": { "smithy.api#documentation": "The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a\n VPC.
" } }, "VpcOptions": { "target": "com.amazonaws.osis#VpcOptions", "traits": { "smithy.api#documentation": "Information about the VPC, including associated subnets and security groups.
" } } }, "traits": { "smithy.api#documentation": "An OpenSearch Ingestion-managed VPC endpoint that will access one or more\n pipelines.
" } }, "com.amazonaws.osis#VpcEndpointManagement": { "type": "enum", "members": { "CUSTOMER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOMER" } }, "SERVICE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SERVICE" } } } }, "com.amazonaws.osis#VpcEndpointServiceName": { "type": "enum", "members": { "OPENSEARCH_SERVERLESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPENSEARCH_SERVERLESS" } } } }, "com.amazonaws.osis#VpcEndpointsList": { "type": "list", "member": { "target": "com.amazonaws.osis#VpcEndpoint" } }, "com.amazonaws.osis#VpcOptions": { "type": "structure", "members": { "SubnetIds": { "target": "com.amazonaws.osis#SubnetIds", "traits": { "smithy.api#documentation": "A list of subnet IDs associated with the VPC endpoint.
", "smithy.api#required": {} } }, "SecurityGroupIds": { "target": "com.amazonaws.osis#SecurityGroupIds", "traits": { "smithy.api#documentation": "A list of security groups associated with the VPC endpoint.
" } }, "VpcAttachmentOptions": { "target": "com.amazonaws.osis#VpcAttachmentOptions", "traits": { "smithy.api#documentation": "Options for attaching a VPC to a pipeline.
" } }, "VpcEndpointManagement": { "target": "com.amazonaws.osis#VpcEndpointManagement", "traits": { "smithy.api#documentation": "Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline.
" } } }, "traits": { "smithy.api#documentation": "Options that specify the subnets and security groups for an OpenSearch Ingestion\n VPC endpoint.
" } } } }