FMS / Client / put_resource_set

put_resource_set#

FMS.Client.put_resource_set(**kwargs)#

Creates the resource set.

An Firewall Manager resource set defines the resources to import into an Firewall Manager policy from another Amazon Web Services service.

Request Syntax

response = client.put_resource_set(
    ResourceSet={
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'UpdateToken': 'string',
        'ResourceTypeList': [
            'string',
        ],
        'LastUpdateTime': datetime(2015, 1, 1),
        'ResourceSetStatus': 'ACTIVE'|'OUT_OF_ADMIN_SCOPE'
    },
    TagList=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

ResourceSet (dict) –
[REQUIRED]

Details about the resource set to be created or updated.>
- Id (string) –
  
  A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name (string) – [REQUIRED]
  
  The descriptive name of the resource set. You can’t change the name of a resource set after you create it.
- Description (string) –
  
  A description of the resource set.
- UpdateToken (string) –
  
  An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.
  
  To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
  
  To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
- ResourceTypeList (list) – [REQUIRED]
  
  Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
  - (string) –
- LastUpdateTime (datetime) –
  
  The last time that the resource set was changed.
- ResourceSetStatus (string) –
  
  Indicates whether the resource set is in or out of an admin’s Region scope.
  - ACTIVE - The administrator can manage and delete the resource set.
  - OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can’t edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won’t be protected.
TagList (list) –
Retrieves the tags associated with the specified resource set. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to “customer” and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
- (dict) –
  
  A collection of key:value pairs associated with an Amazon Web Services resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as “environment”) and the tag value represents a specific value within that category (such as “test,” “development,” or “production”). You can add up to 50 tags to each Amazon Web Services resource.
  - Key (string) – [REQUIRED]
    
    Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as “customer.” Tag keys are case-sensitive.
  - Value (string) – [REQUIRED]
    
    Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as “companyA” or “companyB.” Tag values are case-sensitive.

Return type:

dict

Returns:

Response Syntax

{
    'ResourceSet': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'UpdateToken': 'string',
        'ResourceTypeList': [
            'string',
        ],
        'LastUpdateTime': datetime(2015, 1, 1),
        'ResourceSetStatus': 'ACTIVE'|'OUT_OF_ADMIN_SCOPE'
    },
    'ResourceSetArn': 'string'
}

Response Structure

(dict) –
- ResourceSet (dict) –
  
  Details about the resource set.
  - Id (string) –
    
    A unique identifier for the resource set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
  - Name (string) –
    
    The descriptive name of the resource set. You can’t change the name of a resource set after you create it.
  - Description (string) –
    
    A description of the resource set.
  - UpdateToken (string) –
    
    An optional token that you can use for optimistic locking. Firewall Manager returns a token to your requests that access the resource set. The token marks the state of the resource set resource at the time of the request. Update tokens are not allowed when creating a resource set. After creation, each subsequent update call to the resource set requires the update token.
    
    To make an unconditional change to the resource set, omit the token in your update request. Without the token, Firewall Manager performs your updates regardless of whether the resource set has changed since you last retrieved it.
    
    To make a conditional change to the resource set, provide the token in your update request. Firewall Manager uses the token to ensure that the resource set hasn’t changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the resource set again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
  - ResourceTypeList (list) –
    
    Determines the resources that can be associated to the resource set. Depending on your setting for max results and the number of resource sets, a single call might not return the full list.
    - (string) –
  - LastUpdateTime (datetime) –
    
    The last time that the resource set was changed.
  - ResourceSetStatus (string) –
    
    Indicates whether the resource set is in or out of an admin’s Region scope.
    - ACTIVE - The administrator can manage and delete the resource set.
    - OUT_OF_ADMIN_SCOPE - The administrator can view the resource set, but they can’t edit or delete the resource set. Existing protections stay in place. Any new resource that come into scope of the resource set won’t be protected.
- ResourceSetArn (string) –
  
  The Amazon Resource Name (ARN) of the resource set.

Exceptions

FMS.Client.exceptions.InvalidOperationException
FMS.Client.exceptions.InvalidInputException
FMS.Client.exceptions.LimitExceededException
FMS.Client.exceptions.InternalErrorException