Actions, resources, and condition keys for AWS B2B Data Interchange

AWS B2B Data Interchange (service prefix: b2bi) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

• Learn how to configure this service.

• View a list of the API operations available for this service.

• Learn how to secure this service and its resources by using IAM permission policies.

Actions defined by AWS B2B Data Interchange

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
CreateCapability	Grants permission to create a capability	Write	transformer
				aws:TagKeys aws:RequestTag/${TagKey}
CreatePartnership	Grants permission to create a partnership	Write	capability*
			profile*
				aws:TagKeys aws:RequestTag/${TagKey}
CreateProfile	Grants permission to create a profile	Write		aws:TagKeys aws:RequestTag/${TagKey}
CreateStarterMappingTemplate	Grants permission to generate a starter JSONATA/XSLT template	Write	transformer*
CreateTransformer	Grants permission to create a transformer	Write		aws:TagKeys aws:RequestTag/${TagKey}
DeleteCapability	Grants permission to delete a capability	Write	capability*
DeletePartnership	Grants permission to delete an partnership	Write	partnership*
DeleteProfile	Grants permission to delete a profile	Write	profile*
DeleteTransformer	Grants permission to delete a transformer	Write	transformer*
GetCapability	Grants permission to get a capability	Read	capability*
GetPartnership	Grants permission to get a partnership	Read	partnership*
GetProfile	Grants permission to get a profile	Read	profile*
GetTransformer	Grants permission to get a transformer	Read	transformer*
GetTransformerJob	Grants permission to get a transformer job	Read	transformer*
ListCapabilities	Grants permission to list all capabilities	List
ListPartnerships	Grants permission to list all partnerships	List
ListProfiles	Grants permission to list all profiles	List
ListTagsForResource	Grants permission to list tags for a B2Bi resource	Read	capability
			partnership
			profile
			transformer
ListTransformers	Grants permission to list all transformers	List
StartTransformerJob	Grants permission to transformer a document	Write	transformer*
TagResource	Grants permission to tag a B2Bi resource	Tagging	capability
			partnership
			profile
			transformer
				aws:TagKeys aws:RequestTag/${TagKey}
TestConversion	Grants permission to convert a JSON/XML to an edi document	Write	transformer*
TestMapping	Grants permission to map a sample file	Write	transformer*
TestParsing	Grants permission to parse an edi document	Write	transformer*
UntagResource	Grants permission to untag a B2Bi resource	Tagging	capability
			partnership
			profile
			transformer
				aws:TagKeys
UpdateCapability	Grants permission to update a capability	Write	capability*
			transformer
UpdatePartnership	Grants permission to update a partnership	Write	partnership*
			capability
UpdateProfile	Grants permission to update a profile	Write	profile*
UpdateTransformer	Grants permission to update a transformer	Write	transformer*

Resource types defined by AWS B2B Data Interchange

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
profile	arn:${Partition}:b2bi:${Region}:${Account}:profile/${ResourceId}	aws:ResourceTag/${TagKey}
capability	arn:${Partition}:b2bi:${Region}:${Account}:capability/${ResourceId}	aws:ResourceTag/${TagKey}
partnership	arn:${Partition}:b2bi:${Region}:${Account}:partnership/${ResourceId}	aws:ResourceTag/${TagKey}
transformer	arn:${Partition}:b2bi:${Region}:${Account}:transformer/${ResourceId}	aws:ResourceTag/${TagKey}

Condition keys for AWS B2B Data Interchange

AWS B2B Data Interchange 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