OpenSearchIngestion ******************* Client ====== class OpenSearchIngestion.Client A low-level client representing Amazon OpenSearch Ingestion Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see Getting data into your cluster using OpenSearch Ingestion. import boto3 client = boto3.client('osis') These are the available methods: * can_paginate * close * create_pipeline * delete_pipeline * get_paginator * get_pipeline * get_pipeline_blueprint * get_pipeline_change_progress * get_waiter * list_pipeline_blueprints * list_pipelines * list_tags_for_resource * start_pipeline * stop_pipeline * tag_resource * untag_resource * update_pipeline * validate_pipeline OpenSearchIngestion / Client / get_paginator get_paginator ************* OpenSearchIngestion.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. OpenSearchIngestion / Client / get_pipeline get_pipeline ************ OpenSearchIngestion.Client.get_pipeline(**kwargs) Retrieves information about an OpenSearch Ingestion pipeline. See also: AWS API Documentation **Request Syntax** response = client.get_pipeline( PipelineName='string' ) Parameters: **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline. Return type: dict Returns: **Response Syntax** { 'Pipeline': { 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineConfigurationBody': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'IngestEndpointUrls': [ 'string', ], 'LogPublishingOptions': { 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'VpcOptions': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' } }, ], 'BufferOptions': { 'PersistentBufferEnabled': True|False }, 'EncryptionAtRestOptions': { 'KmsKeyArn': 'string' }, 'VpcEndpointService': 'string', 'ServiceVpcEndpoints': [ { 'ServiceName': 'OPENSEARCH_SERVERLESS', 'VpcEndpointId': 'string' }, ], 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PipelineRoleArn': 'string' } } **Response Structure** * *(dict) --* * **Pipeline** *(dict) --* Detailed information about the requested pipeline. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* The reason for the current status of the pipeline. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineConfigurationBody** *(string) --* The Data Prepper pipeline configuration in YAML format. * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **IngestEndpointUrls** *(list) --* The ingestion endpoints for the pipeline, which you can send data to. * *(string) --* * **LogPublishingOptions** *(dict) --* Key-value pairs that represent log publishing settings. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcEndpoints** *(list) --* The VPC interface endpoints that have access to the pipeline. * *(dict) --* An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcId** *(string) --* The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC. * **VpcOptions** *(dict) --* Information about the VPC, including associated subnets and security groups. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** *(dict) --* Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the "EncryptionAtRestOptions". For more information, see Persistent buffering. * **PersistentBufferEnabled** *(boolean) --* Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** *(dict) --* Options to control how OpenSearch encrypts buffer data. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **VpcEndpointService** *(string) --* The VPC endpoint service name for the pipeline. * **ServiceVpcEndpoints** *(list) --* A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services. * *(dict) --* A container for information about VPC endpoints that were created to other services * **ServiceName** *(string) --* The name of the service for which a VPC endpoint was created. * **VpcEndpointId** *(string) --* The unique identifier of the VPC endpoint that was created. * **Destinations** *(list) --* Destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" OpenSearchIngestion / Client / can_paginate can_paginate ************ OpenSearchIngestion.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. OpenSearchIngestion / Client / list_pipelines list_pipelines ************** OpenSearchIngestion.Client.list_pipelines(**kwargs) Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see Viewing Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.list_pipelines( MaxResults=123, NextToken='string' ) Parameters: * **MaxResults** (*integer*) -- An optional parameter that specifies the maximum number of results to return. You can use "nextToken" to get the next page of results. * **NextToken** (*string*) -- If your initial "ListPipelines" operation returns a "nextToken", you can include the returned "nextToken" in subsequent "ListPipelines" operations, which returns results in the next page. Return type: dict Returns: **Response Syntax** { 'NextToken': 'string', 'Pipelines': [ { 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] }, ] } **Response Structure** * *(dict) --* * **NextToken** *(string) --* When "nextToken" is returned, there are more results available. The value of "nextToken" is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. * **Pipelines** *(list) --* A list of all existing Data Prepper pipelines. * *(dict) --* Summary information for an OpenSearch Ingestion pipeline. * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* Information about a pipeline's current status. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **Destinations** *(list) --* A list of destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.InvalidPaginationTokenExc eption" OpenSearchIngestion / Client / list_tags_for_resource list_tags_for_resource ********************** OpenSearchIngestion.Client.list_tags_for_resource(**kwargs) Lists all resource tags associated with an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( Arn='string' ) Parameters: **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pipeline to retrieve tags for. Return type: dict Returns: **Response Syntax** { 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ] } **Response Structure** * *(dict) --* * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" OpenSearchIngestion / Client / untag_resource untag_resource ************** OpenSearchIngestion.Client.untag_resource(**kwargs) Removes one or more tags from an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( Arn='string', TagKeys=[ 'string', ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pipeline to remove tags from. * **TagKeys** (*list*) -- **[REQUIRED]** The tag keys to remove. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" OpenSearchIngestion / Client / get_waiter get_waiter ********** OpenSearchIngestion.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" OpenSearchIngestion / Client / delete_pipeline delete_pipeline *************** OpenSearchIngestion.Client.delete_pipeline(**kwargs) Deletes an OpenSearch Ingestion pipeline. For more information, see Deleting Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.delete_pipeline( PipelineName='string' ) Parameters: **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline to delete. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.ConflictException" OpenSearchIngestion / Client / stop_pipeline stop_pipeline ************* OpenSearchIngestion.Client.stop_pipeline(**kwargs) Stops an OpenSearch Ingestion pipeline. For more information, see Stopping an OpenSearch Ingestion pipeline. See also: AWS API Documentation **Request Syntax** response = client.stop_pipeline( PipelineName='string' ) Parameters: **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline to stop. Return type: dict Returns: **Response Syntax** { 'Pipeline': { 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineConfigurationBody': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'IngestEndpointUrls': [ 'string', ], 'LogPublishingOptions': { 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'VpcOptions': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' } }, ], 'BufferOptions': { 'PersistentBufferEnabled': True|False }, 'EncryptionAtRestOptions': { 'KmsKeyArn': 'string' }, 'VpcEndpointService': 'string', 'ServiceVpcEndpoints': [ { 'ServiceName': 'OPENSEARCH_SERVERLESS', 'VpcEndpointId': 'string' }, ], 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PipelineRoleArn': 'string' } } **Response Structure** * *(dict) --* * **Pipeline** *(dict) --* Information about an existing OpenSearch Ingestion pipeline. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* The reason for the current status of the pipeline. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineConfigurationBody** *(string) --* The Data Prepper pipeline configuration in YAML format. * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **IngestEndpointUrls** *(list) --* The ingestion endpoints for the pipeline, which you can send data to. * *(string) --* * **LogPublishingOptions** *(dict) --* Key-value pairs that represent log publishing settings. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcEndpoints** *(list) --* The VPC interface endpoints that have access to the pipeline. * *(dict) --* An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcId** *(string) --* The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC. * **VpcOptions** *(dict) --* Information about the VPC, including associated subnets and security groups. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** *(dict) --* Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the "EncryptionAtRestOptions". For more information, see Persistent buffering. * **PersistentBufferEnabled** *(boolean) --* Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** *(dict) --* Options to control how OpenSearch encrypts buffer data. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **VpcEndpointService** *(string) --* The VPC endpoint service name for the pipeline. * **ServiceVpcEndpoints** *(list) --* A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services. * *(dict) --* A container for information about VPC endpoints that were created to other services * **ServiceName** *(string) --* The name of the service for which a VPC endpoint was created. * **VpcEndpointId** *(string) --* The unique identifier of the VPC endpoint that was created. * **Destinations** *(list) --* Destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ConflictException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.ValidationException" OpenSearchIngestion / Client / get_pipeline_blueprint get_pipeline_blueprint ********************** OpenSearchIngestion.Client.get_pipeline_blueprint(**kwargs) Retrieves information about a specific blueprint for OpenSearch Ingestion. Blueprints are templates for the configuration needed for a "CreatePipeline" request. For more information, see Using blueprints to create a pipeline. See also: AWS API Documentation **Request Syntax** response = client.get_pipeline_blueprint( BlueprintName='string', Format='string' ) Parameters: * **BlueprintName** (*string*) -- **[REQUIRED]** The name of the blueprint to retrieve. * **Format** (*string*) -- The format format of the blueprint to retrieve. Return type: dict Returns: **Response Syntax** { 'Blueprint': { 'BlueprintName': 'string', 'PipelineConfigurationBody': 'string', 'DisplayName': 'string', 'DisplayDescription': 'string', 'Service': 'string', 'UseCase': 'string' }, 'Format': 'string' } **Response Structure** * *(dict) --* * **Blueprint** *(dict) --* The requested blueprint in YAML format. * **BlueprintName** *(string) --* The name of the blueprint. * **PipelineConfigurationBody** *(string) --* The YAML configuration of the blueprint. * **DisplayName** *(string) --* The display name of the blueprint. * **DisplayDescription** *(string) --* A description of the blueprint. * **Service** *(string) --* The name of the service that the blueprint is associated with. * **UseCase** *(string) --* The use case that the blueprint relates to. * **Format** *(string) --* The format of the blueprint. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" OpenSearchIngestion / Client / get_pipeline_change_progress get_pipeline_change_progress **************************** OpenSearchIngestion.Client.get_pipeline_change_progress(**kwargs) 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. For more information, see Tracking the status of pipeline creation. See also: AWS API Documentation **Request Syntax** response = client.get_pipeline_change_progress( PipelineName='string' ) Parameters: **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline. Return type: dict Returns: **Response Syntax** { 'ChangeProgressStatuses': [ { 'StartTime': datetime(2015, 1, 1), 'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED', 'TotalNumberOfStages': 123, 'ChangeProgressStages': [ { 'Name': 'string', 'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED', 'Description': 'string', 'LastUpdatedAt': datetime(2015, 1, 1) }, ] }, ] } **Response Structure** * *(dict) --* * **ChangeProgressStatuses** *(list) --* The current status of the change happening on the pipeline. * *(dict) --* The progress details of a pipeline configuration change. * **StartTime** *(datetime) --* The time at which the configuration change is made on the pipeline. * **Status** *(string) --* The overall status of the pipeline configuration change. * **TotalNumberOfStages** *(integer) --* The total number of stages required for the pipeline configuration change. * **ChangeProgressStages** *(list) --* Information about the stages that the pipeline is going through to perform the configuration change. * *(dict) --* Progress details for a specific stage of a pipeline configuration change. * **Name** *(string) --* The name of the stage. * **Status** *(string) --* The current status of the stage that the change is in. * **Description** *(string) --* A description of the stage. * **LastUpdatedAt** *(datetime) --* The most recent updated timestamp of the stage. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" OpenSearchIngestion / Client / validate_pipeline validate_pipeline ***************** OpenSearchIngestion.Client.validate_pipeline(**kwargs) Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation. For more information, see Creating Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.validate_pipeline( PipelineConfigurationBody='string' ) Parameters: **PipelineConfigurationBody** (*string*) -- **[REQUIRED]** 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 "\n". Return type: dict Returns: **Response Syntax** { 'isValid': True|False, 'Errors': [ { 'Message': 'string' }, ] } **Response Structure** * *(dict) --* * **isValid** *(boolean) --* A boolean indicating whether or not the pipeline configuration is valid. * **Errors** *(list) --* A list of errors if the configuration is invalid. * *(dict) --* A validation message associated with a "ValidatePipeline" request in OpenSearch Ingestion. * **Message** *(string) --* The validation message. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.ValidationException" OpenSearchIngestion / Client / close close ***** OpenSearchIngestion.Client.close() Closes underlying endpoint connections. OpenSearchIngestion / Client / update_pipeline update_pipeline *************** OpenSearchIngestion.Client.update_pipeline(**kwargs) Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.update_pipeline( PipelineName='string', MinUnits=123, MaxUnits=123, PipelineConfigurationBody='string', LogPublishingOptions={ 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, BufferOptions={ 'PersistentBufferEnabled': True|False }, EncryptionAtRestOptions={ 'KmsKeyArn': 'string' }, PipelineRoleArn='string' ) Parameters: * **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline to update. * **MinUnits** (*integer*) -- The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** (*integer*) -- The maximum pipeline capacity, in Ingestion Compute Units (ICUs) * **PipelineConfigurationBody** (*string*) -- 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 "\n". * **LogPublishingOptions** (*dict*) -- Key-value pairs to configure log publishing. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* **[REQUIRED]** 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **BufferOptions** (*dict*) -- Key-value pairs to configure persistent buffering for the pipeline. * **PersistentBufferEnabled** *(boolean) --* **[REQUIRED]** Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** (*dict*) -- Key-value pairs to configure encryption for data that is written to a persistent buffer. * **KmsKeyArn** *(string) --* **[REQUIRED]** The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **PipelineRoleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see Setting up roles and users in Amazon OpenSearch Ingestion. Return type: dict Returns: **Response Syntax** { 'Pipeline': { 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineConfigurationBody': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'IngestEndpointUrls': [ 'string', ], 'LogPublishingOptions': { 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'VpcOptions': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' } }, ], 'BufferOptions': { 'PersistentBufferEnabled': True|False }, 'EncryptionAtRestOptions': { 'KmsKeyArn': 'string' }, 'VpcEndpointService': 'string', 'ServiceVpcEndpoints': [ { 'ServiceName': 'OPENSEARCH_SERVERLESS', 'VpcEndpointId': 'string' }, ], 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PipelineRoleArn': 'string' } } **Response Structure** * *(dict) --* * **Pipeline** *(dict) --* Container for information about the updated pipeline. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* The reason for the current status of the pipeline. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineConfigurationBody** *(string) --* The Data Prepper pipeline configuration in YAML format. * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **IngestEndpointUrls** *(list) --* The ingestion endpoints for the pipeline, which you can send data to. * *(string) --* * **LogPublishingOptions** *(dict) --* Key-value pairs that represent log publishing settings. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcEndpoints** *(list) --* The VPC interface endpoints that have access to the pipeline. * *(dict) --* An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcId** *(string) --* The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC. * **VpcOptions** *(dict) --* Information about the VPC, including associated subnets and security groups. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** *(dict) --* Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the "EncryptionAtRestOptions". For more information, see Persistent buffering. * **PersistentBufferEnabled** *(boolean) --* Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** *(dict) --* Options to control how OpenSearch encrypts buffer data. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **VpcEndpointService** *(string) --* The VPC endpoint service name for the pipeline. * **ServiceVpcEndpoints** *(list) --* A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services. * *(dict) --* A container for information about VPC endpoints that were created to other services * **ServiceName** *(string) --* The name of the service for which a VPC endpoint was created. * **VpcEndpointId** *(string) --* The unique identifier of the VPC endpoint that was created. * **Destinations** *(list) --* Destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.ConflictException" OpenSearchIngestion / Client / tag_resource tag_resource ************ OpenSearchIngestion.Client.tag_resource(**kwargs) Tags an OpenSearch Ingestion pipeline. For more information, see Tagging Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( Arn='string', Tags=[ { 'Key': 'string', 'Value': 'string' }, ] ) Parameters: * **Arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the pipeline to tag. * **Tags** (*list*) -- **[REQUIRED]** The list of key-value tags to add to the pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.LimitExceededException" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" OpenSearchIngestion / Client / list_pipeline_blueprints list_pipeline_blueprints ************************ OpenSearchIngestion.Client.list_pipeline_blueprints() Retrieves a list of all available blueprints for Data Prepper. For more information, see Using blueprints to create a pipeline. See also: AWS API Documentation **Request Syntax** response = client.list_pipeline_blueprints() Return type: dict Returns: **Response Syntax** { 'Blueprints': [ { 'BlueprintName': 'string', 'DisplayName': 'string', 'DisplayDescription': 'string', 'Service': 'string', 'UseCase': 'string' }, ] } **Response Structure** * *(dict) --* * **Blueprints** *(list) --* A list of available blueprints for Data Prepper. * *(dict) --* A summary of an OpenSearch Ingestion blueprint. * **BlueprintName** *(string) --* The name of the blueprint. * **DisplayName** *(string) --* The display name of the blueprint. * **DisplayDescription** *(string) --* A description of the blueprint. * **Service** *(string) --* The name of the service that the blueprint is associated with. * **UseCase** *(string) --* The use case that the blueprint relates to. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.InvalidPaginationTokenExc eption" OpenSearchIngestion / Client / create_pipeline create_pipeline *************** OpenSearchIngestion.Client.create_pipeline(**kwargs) Creates an OpenSearch Ingestion pipeline. For more information, see Creating Amazon OpenSearch Ingestion pipelines. See also: AWS API Documentation **Request Syntax** response = client.create_pipeline( PipelineName='string', MinUnits=123, MaxUnits=123, PipelineConfigurationBody='string', LogPublishingOptions={ 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, VpcOptions={ 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' }, BufferOptions={ 'PersistentBufferEnabled': True|False }, EncryptionAtRestOptions={ 'KmsKeyArn': 'string' }, Tags=[ { 'Key': 'string', 'Value': 'string' }, ], PipelineRoleArn='string' ) Parameters: * **PipelineName** (*string*) -- **[REQUIRED]** 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. * **MinUnits** (*integer*) -- **[REQUIRED]** The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** (*integer*) -- **[REQUIRED]** The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **PipelineConfigurationBody** (*string*) -- **[REQUIRED]** 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 "\n". * **LogPublishingOptions** (*dict*) -- Key-value pairs to configure log publishing. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* **[REQUIRED]** 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcOptions** (*dict*) -- Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint. * **SubnetIds** *(list) --* **[REQUIRED]** A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* **[REQUIRED]** Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** (*dict*) -- Key-value pairs to configure persistent buffering for the pipeline. * **PersistentBufferEnabled** *(boolean) --* **[REQUIRED]** Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** (*dict*) -- Key-value pairs to configure encryption for data that is written to a persistent buffer. * **KmsKeyArn** *(string) --* **[REQUIRED]** The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **Tags** (*list*) -- List of tags to add to the pipeline upon creation. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* **[REQUIRED]** The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* **[REQUIRED]** The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** (*string*) -- The Amazon Resource Name (ARN) of an IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. For more information, see Setting up roles and users in Amazon OpenSearch Ingestion. Return type: dict Returns: **Response Syntax** { 'Pipeline': { 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineConfigurationBody': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'IngestEndpointUrls': [ 'string', ], 'LogPublishingOptions': { 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'VpcOptions': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' } }, ], 'BufferOptions': { 'PersistentBufferEnabled': True|False }, 'EncryptionAtRestOptions': { 'KmsKeyArn': 'string' }, 'VpcEndpointService': 'string', 'ServiceVpcEndpoints': [ { 'ServiceName': 'OPENSEARCH_SERVERLESS', 'VpcEndpointId': 'string' }, ], 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PipelineRoleArn': 'string' } } **Response Structure** * *(dict) --* * **Pipeline** *(dict) --* Container for information about the created pipeline. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* The reason for the current status of the pipeline. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineConfigurationBody** *(string) --* The Data Prepper pipeline configuration in YAML format. * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **IngestEndpointUrls** *(list) --* The ingestion endpoints for the pipeline, which you can send data to. * *(string) --* * **LogPublishingOptions** *(dict) --* Key-value pairs that represent log publishing settings. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcEndpoints** *(list) --* The VPC interface endpoints that have access to the pipeline. * *(dict) --* An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcId** *(string) --* The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC. * **VpcOptions** *(dict) --* Information about the VPC, including associated subnets and security groups. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** *(dict) --* Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the "EncryptionAtRestOptions". For more information, see Persistent buffering. * **PersistentBufferEnabled** *(boolean) --* Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** *(dict) --* Options to control how OpenSearch encrypts buffer data. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **VpcEndpointService** *(string) --* The VPC endpoint service name for the pipeline. * **ServiceVpcEndpoints** *(list) --* A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services. * *(dict) --* A container for information about VPC endpoints that were created to other services * **ServiceName** *(string) --* The name of the service for which a VPC endpoint was created. * **VpcEndpointId** *(string) --* The unique identifier of the VPC endpoint that was created. * **Destinations** *(list) --* Destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.LimitExceededException" * "OpenSearchIngestion.Client.exceptions.ValidationException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ResourceAlreadyExistsExce ption" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" OpenSearchIngestion / Client / start_pipeline start_pipeline ************** OpenSearchIngestion.Client.start_pipeline(**kwargs) Starts an OpenSearch Ingestion pipeline. For more information, see Starting an OpenSearch Ingestion pipeline. See also: AWS API Documentation **Request Syntax** response = client.start_pipeline( PipelineName='string' ) Parameters: **PipelineName** (*string*) -- **[REQUIRED]** The name of the pipeline to start. Return type: dict Returns: **Response Syntax** { 'Pipeline': { 'PipelineName': 'string', 'PipelineArn': 'string', 'MinUnits': 123, 'MaxUnits': 123, 'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED', 'StatusReason': { 'Description': 'string' }, 'PipelineConfigurationBody': 'string', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'IngestEndpointUrls': [ 'string', ], 'LogPublishingOptions': { 'IsLoggingEnabled': True|False, 'CloudWatchLogDestination': { 'LogGroup': 'string' } }, 'VpcEndpoints': [ { 'VpcEndpointId': 'string', 'VpcId': 'string', 'VpcOptions': { 'SubnetIds': [ 'string', ], 'SecurityGroupIds': [ 'string', ], 'VpcAttachmentOptions': { 'AttachToVpc': True|False, 'CidrBlock': 'string' }, 'VpcEndpointManagement': 'CUSTOMER'|'SERVICE' } }, ], 'BufferOptions': { 'PersistentBufferEnabled': True|False }, 'EncryptionAtRestOptions': { 'KmsKeyArn': 'string' }, 'VpcEndpointService': 'string', 'ServiceVpcEndpoints': [ { 'ServiceName': 'OPENSEARCH_SERVERLESS', 'VpcEndpointId': 'string' }, ], 'Destinations': [ { 'ServiceName': 'string', 'Endpoint': 'string' }, ], 'Tags': [ { 'Key': 'string', 'Value': 'string' }, ], 'PipelineRoleArn': 'string' } } **Response Structure** * *(dict) --* * **Pipeline** *(dict) --* Information about an existing OpenSearch Ingestion pipeline. * **PipelineName** *(string) --* The name of the pipeline. * **PipelineArn** *(string) --* The Amazon Resource Name (ARN) of the pipeline. * **MinUnits** *(integer) --* The minimum pipeline capacity, in Ingestion Compute Units (ICUs). * **MaxUnits** *(integer) --* The maximum pipeline capacity, in Ingestion Compute Units (ICUs). * **Status** *(string) --* The current status of the pipeline. * **StatusReason** *(dict) --* The reason for the current status of the pipeline. * **Description** *(string) --* A description of why a pipeline has a certain status. * **PipelineConfigurationBody** *(string) --* The Data Prepper pipeline configuration in YAML format. * **CreatedAt** *(datetime) --* The date and time when the pipeline was created. * **LastUpdatedAt** *(datetime) --* The date and time when the pipeline was last updated. * **IngestEndpointUrls** *(list) --* The ingestion endpoints for the pipeline, which you can send data to. * *(string) --* * **LogPublishingOptions** *(dict) --* Key-value pairs that represent log publishing settings. * **IsLoggingEnabled** *(boolean) --* Whether logs should be published. * **CloudWatchLogDestination** *(dict) --* The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch Logs. This parameter is required if "IsLoggingEnabled" is set to "true". * **LogGroup** *(string) --* 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, "/aws/vendedlogs/OpenSearchService/pipelines". * **VpcEndpoints** *(list) --* The VPC interface endpoints that have access to the pipeline. * *(dict) --* An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines. * **VpcEndpointId** *(string) --* The unique identifier of the endpoint. * **VpcId** *(string) --* The ID for your VPC. Amazon Web Services PrivateLink generates this value when you create a VPC. * **VpcOptions** *(dict) --* Information about the VPC, including associated subnets and security groups. * **SubnetIds** *(list) --* A list of subnet IDs associated with the VPC endpoint. * *(string) --* * **SecurityGroupIds** *(list) --* A list of security groups associated with the VPC endpoint. * *(string) --* * **VpcAttachmentOptions** *(dict) --* Options for attaching a VPC to a pipeline. * **AttachToVpc** *(boolean) --* Whether a VPC is attached to the pipeline. * **CidrBlock** *(string) --* The CIDR block to be reserved for OpenSearch Ingestion to create elastic network interfaces (ENIs). * **VpcEndpointManagement** *(string) --* Defines whether you or Amazon OpenSearch Ingestion service create and manage the VPC endpoint configured for the pipeline. * **BufferOptions** *(dict) --* Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the "EncryptionAtRestOptions". For more information, see Persistent buffering. * **PersistentBufferEnabled** *(boolean) --* Whether persistent buffering should be enabled. * **EncryptionAtRestOptions** *(dict) --* Options to control how OpenSearch encrypts buffer data. * **KmsKeyArn** *(string) --* The ARN of the KMS key used to encrypt buffer data. By default, data is encrypted using an Amazon Web Services owned key. * **VpcEndpointService** *(string) --* The VPC endpoint service name for the pipeline. * **ServiceVpcEndpoints** *(list) --* A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services. * *(dict) --* A container for information about VPC endpoints that were created to other services * **ServiceName** *(string) --* The name of the service for which a VPC endpoint was created. * **VpcEndpointId** *(string) --* The unique identifier of the VPC endpoint that was created. * **Destinations** *(list) --* Destinations to which the pipeline writes data. * *(dict) --* An object representing the destination of a pipeline. * **ServiceName** *(string) --* The name of the service receiving data from the pipeline. * **Endpoint** *(string) --* The endpoint receiving data from the pipeline. * **Tags** *(list) --* A list of tags associated with the given pipeline. * *(dict) --* A tag (key-value pair) for an OpenSearch Ingestion pipeline. * **Key** *(string) --* The tag key. Tag keys must be unique for the pipeline to which they are attached. * **Value** *(string) --* The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of "project : Trinity" and "cost-center : Trinity" * **PipelineRoleArn** *(string) --* The Amazon Resource Name (ARN) of the IAM role that provides the required permissions for a pipeline to read from the source and write to the sink. **Exceptions** * "OpenSearchIngestion.Client.exceptions.DisabledOperationExceptio n" * "OpenSearchIngestion.Client.exceptions.AccessDeniedException" * "OpenSearchIngestion.Client.exceptions.ConflictException" * "OpenSearchIngestion.Client.exceptions.InternalException" * "OpenSearchIngestion.Client.exceptions.ResourceNotFoundException" * "OpenSearchIngestion.Client.exceptions.ValidationException"