RAM / Client / create_permission_version

create_permission_version#

RAM.Client.create_permission_version(**kwargs)#

Creates a new version of the specified customer managed permission. The new version is automatically set as the default version of the customer managed permission. New resource shares automatically use the default permission. Existing resource shares continue to use their original permission versions, but you can use ReplacePermissionAssociations to update them.

If the specified customer managed permission already has the maximum of 5 versions, then you must delete one of the existing versions before you can create a new one.

Request Syntax

response = client.create_permission_version(
    permissionArn='string',
    policyTemplate='string',
    clientToken='string'
)

Parameters:

permissionArn (string) –
[REQUIRED]

Specifies the Amazon Resource Name (ARN) of the customer managed permission you’re creating a new version for.
policyTemplate (string) –
[REQUIRED]

A string in JSON format string that contains the following elements of a resource-based policy:
- Effect: must be set to ALLOW.
- Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.
- Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.
This template can’t include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.
clientToken (string) –
Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don’t provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

Return type:

dict

Returns:

Response Syntax

{
    'permission': {
        'arn': 'string',
        'version': 'string',
        'defaultVersion': True|False,
        'name': 'string',
        'resourceType': 'string',
        'permission': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'isResourceTypeDefault': True|False,
        'permissionType': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
        'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD',
        'status': 'ATTACHABLE'|'UNATTACHABLE'|'DELETING'|'DELETED',
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ]
    },
    'clientToken': 'string'
}

Response Structure

(dict) –
- permission (dict) –
  
  Information about a RAM managed permission.
  - arn (string) –
    
    The Amazon Resource Name (ARN) of this RAM managed permission.
  - version (string) –
    
    The version of the permission described in this response.
  - defaultVersion (boolean) –
    
    Specifies whether the version of the permission represented in this response is the default version for this permission.
  - name (string) –
    
    The name of this permission.
  - resourceType (string) –
    
    The resource type to which this permission applies.
  - permission (string) –
    
    The permission’s effect and actions in JSON format. The effect indicates whether the specified actions are allowed or denied. The actions list the operations to which the principal is granted or denied access.
  - creationTime (datetime) –
    
    The date and time when the permission was created.
  - lastUpdatedTime (datetime) –
    
    The date and time when the permission was last updated.
  - isResourceTypeDefault (boolean) –
    
    Specifies whether the version of the permission represented in this response is the default version for all resources of this resource type.
  - permissionType (string) –
    
    The type of managed permission. This can be one of the following values:
    - AWS_MANAGED – Amazon Web Services created and manages this managed permission. You can associate it with your resource shares, but you can’t modify it.
    - CUSTOMER_MANAGED – You, or another principal in your account created this managed permission. You can associate it with your resource shares and create new versions that have different permissions.
  - featureSet (string) –
    
    Indicates what features are available for this resource share. This parameter can have one of the following values:
    - STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.
    - CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer’s behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can’t modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.
    - PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.
  - status (string) –
    
    The current status of the association between the permission and the resource share. The following are the possible values:
    - ATTACHABLE – This permission or version can be associated with resource shares.
    - UNATTACHABLE – This permission or version can’t currently be associated with resource shares.
    - DELETING – This permission or version is in the process of being deleted.
    - DELETED – This permission or version is deleted.
  - tags (list) –
    
    The tag key and value pairs attached to the resource share.
    - (dict) –
      
      A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.
      
      For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
      - key (string) –
        
        The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.
      - value (string) –
        
        The string value attached to the tag. The value can be an empty string. Key values are case sensitive.
- clientToken (string) –
  
  The idempotency identifier associated with this request. If you want to repeat the same operation in an idempotent manner then you must include this value in the clientToken request parameter of that later call. All other parameters must also have the same values that you used in the first call.

Exceptions

RAM.Client.exceptions.InvalidParameterException
RAM.Client.exceptions.InvalidPolicyException
RAM.Client.exceptions.ServerInternalException
RAM.Client.exceptions.ServiceUnavailableException
RAM.Client.exceptions.UnknownResourceException
RAM.Client.exceptions.MalformedPolicyTemplateException
RAM.Client.exceptions.MalformedArnException
RAM.Client.exceptions.InvalidClientTokenException
RAM.Client.exceptions.IdempotentParameterMismatchException
RAM.Client.exceptions.PermissionVersionsLimitExceededException