Actions, resources, and condition keys for Amazon OpenSearch Ingestion - Service Authorization Reference
ActionsResource typesCondition keys

Actions, resources, and condition keys for Amazon OpenSearch Ingestion

Amazon OpenSearch Ingestion (service prefix: osis) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by Amazon OpenSearch Ingestion

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
CreatePipeline Grants permission to create an OpenSearch Ingestion pipeline Write

aws:TagKeys

aws:RequestTag/${TagKey}

iam:CreateServiceLinkedRole

iam:PassRole

kms:DescribeKey

kms:GenerateDataKeyWithoutPlaintext

logs:CreateLogDelivery

DeletePipeline Grants permission to delete an OpenSearch Ingestion pipeline Write

pipeline*

logs:DeleteLogDelivery

logs:GetLogDelivery

logs:ListLogDeliveries

GetPipeline Grants permission to retrieve configuration information for an OpenSearch Ingestion pipeline Read

pipeline*

GetPipelineBlueprint Grants permission to get the contents of an OpenSearch Ingestion pipeline blueprint Read

pipeline-blueprint*

GetPipelineChangeProgress Grants permission to get granular information about the status of an OpenSearch Ingestion pipeline Read

pipeline*

Ingest Grants permission to ingest data through an OpenSearch Ingestion pipeline Write

pipeline*

ListPipelineBlueprints Grants permission to list the names of available blueprints for an OpenSearch Ingestion pipeline configuration List
ListPipelines Grants permission to list basic configuration for each OpenSearch Ingestion pipeline in the current account and Region List
ListTagsForResource Grants permission to list all resource tags associated with an OpenSearch Ingestion pipeline Read

pipeline*

StartPipeline Grants permission to start an OpenSearch Ingestion pipeline Write

pipeline*

StopPipeline Grants permission to stop an OpenSearch Ingestion pipeline Write

pipeline*

TagResource Grants permission to attach resource tags to an OpenSearch Ingestion pipeline Tagging

pipeline*

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Grants permission to remove resource tags from an OpenSearch Ingestion Service pipeline Tagging

pipeline*

aws:TagKeys

UpdatePipeline Grants permission to modify the configuration of an OpenSearch Ingestion pipeline Write

pipeline*

iam:PassRole

kms:DescribeKey

kms:GenerateDataKeyWithoutPlaintext

logs:GetLogDelivery

logs:ListLogDeliveries

logs:UpdateLogDelivery

ValidatePipeline Grants permission to validate the configuration of an OpenSearch Ingestion pipeline Read

Resource types defined by Amazon OpenSearch Ingestion

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
pipeline arn:${Partition}:osis:${Region}:${Account}:pipeline/${PipelineName}

aws:ResourceTag/${TagKey}

pipeline-blueprint arn:${Partition}:osis:${Region}:${Account}:blueprint/${BlueprintName}

Condition keys for Amazon OpenSearch Ingestion

Amazon OpenSearch Ingestion defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters access by the tags that are passed in the request String
aws:ResourceTag/${TagKey} Filters access by the tags associated with the resource String
aws:TagKeys Filters access by the tag keys that are passed in the request ArrayOfString