2026/11/16 - AWS Network Manager - 12 new api methods
Changes Context Sharing with Firewalls
Returns the context entries that were added to or removed from a context store after the specified version. The context store must be in the AVAILABLE state.
See also: AWS API Documentation
Request Syntax
client.list_context_changes(
ContextStoreId='string',
FromVersionId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the context store.
string
[REQUIRED]
The version to return changes from. Specify a version returned by ListContexts, GetContextVersion, or the ToVersionId of a previous ListContextChanges request. If the version is no longer available, the request fails, and you must call ListContexts to get the current context entries.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'ContextChanges': [
{
'ChangeType': 'ADDED'|'REMOVED',
'Context': {
'ContextId': 'string',
'ContextType': 'string',
'SegmentType': 'string',
'PublicId': 'string',
'Region': 'string',
'AvailabilityZone': 'string',
'AttachmentType': 'string'
}
},
],
'FromVersionId': 'string',
'ToVersionId': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
ContextChanges (list) --
The context entries that were added or removed.
(dict) --
Describes a context entry that was added to or removed from a context store.
ChangeType (string) --
The type of change. The possible values are the following:
ADDED: The context entry was added to the context store.
REMOVED: The context entry was removed from the context store.
Context (dict) --
The context entry that was added or removed.
ContextId (string) --
The ID of the context entry.
ContextType (string) --
The type of the context entry, for example SegmentId, Subnet, or Attachment.
SegmentType (string) --
The type of the segment, for example SecurityGroup. Network Manager returns this value only when the context type is SegmentId.
PublicId (string) --
The ID of the resource, for example a security group ID, subnet ID, or transit gateway attachment ID.
Region (string) --
The Amazon Web Services Region of the resource.
AvailabilityZone (string) --
The ID of the Availability Zone of the resource, for example use1-az2. Network Manager returns this value only when the context type is Subnet.
AttachmentType (string) --
The type of the attachment, for example VPC. Network Manager returns this value only when the context type is Attachment.
FromVersionId (string) --
The version that the changes start from.
ToVersionId (string) --
The version that the changes bring the context entries up to. To get later changes, specify this value as FromVersionId in your next request. All pages of the same request return the same version.
NextToken (string) --
The token for the next page of results.
Returns the transit gateway associations of a context store.
See also: AWS API Documentation
Request Syntax
client.list_context_store_associations(
ContextStoreId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the context store.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'ContextStoreAssociations': [
{
'ContextStoreId': 'string',
'TransitGatewayArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'ASSOCIATING'|'ASSOCIATED'|'DISASSOCIATING'|'FAILED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContextStoreAssociations (list) --
The context store associations.
(dict) --
Describes the association between a context store and a transit gateway.
ContextStoreId (string) --
The ID of the context store.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
CreatedAt (datetime) --
The date and time that the association was created.
State (string) --
The state of the association. The possible values are the following:
ASSOCIATING: The transit gateway is being associated with the context store.
ASSOCIATED: The transit gateway is associated with the context store.
DISASSOCIATING: The transit gateway is being disassociated from the context store.
FAILED: The association failed. To remove it, disassociate the transit gateway.
NextToken (string) --
The token for the next page of results.
Creates a context store in a global network. A context store maintains context entries, such as security groups, subnets, and attachments, for the resources connected to the transit gateways that you associate with it.
The context store is in the PENDING state when it's created, and changes to AVAILABLE when it's ready to use.
See also: AWS API Documentation
Request Syntax
client.create_context_store(
GlobalNetworkId='string',
Description='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
ClientToken='string'
)
string
[REQUIRED]
The ID of the global network to create the context store in.
string
A description of the context store.
Constraints: Maximum length of 256 characters. Only printable ASCII characters are allowed.
list
The tags to apply to the context store during creation.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
Response Syntax
{
'ContextStore': {
'GlobalNetworkId': 'string',
'ContextStoreId': 'string',
'ContextStoreArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ContextStore (dict) --
Information about the context store.
GlobalNetworkId (string) --
The ID of the global network that the context store belongs to.
ContextStoreId (string) --
The ID of the context store.
ContextStoreArn (string) --
The Amazon Resource Name (ARN) of the context store.
Description (string) --
The description of the context store.
CreatedAt (datetime) --
The date and time that the context store was created.
State (string) --
The state of the context store. The possible values are the following:
PENDING: The context store is being created.
AVAILABLE: The context store is ready to use.
UPDATING: The context store is being updated.
DELETING: The context store is being deleted.
DELETED: The context store is deleted.
Tags (list) --
The tags associated with the context store.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Updates the description of a context store. The context store must be in the AVAILABLE state.
See also: AWS API Documentation
Request Syntax
client.update_context_store(
ContextStoreId='string',
Description='string'
)
string
[REQUIRED]
The ID of the context store.
string
The new description of the context store.
Constraints: Maximum length of 256 characters. Only printable ASCII characters are allowed.
dict
Response Syntax
{
'ContextStore': {
'GlobalNetworkId': 'string',
'ContextStoreId': 'string',
'ContextStoreArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ContextStore (dict) --
Information about the context store.
GlobalNetworkId (string) --
The ID of the global network that the context store belongs to.
ContextStoreId (string) --
The ID of the context store.
ContextStoreArn (string) --
The Amazon Resource Name (ARN) of the context store.
Description (string) --
The description of the context store.
CreatedAt (datetime) --
The date and time that the context store was created.
State (string) --
The state of the context store. The possible values are the following:
PENDING: The context store is being created.
AVAILABLE: The context store is ready to use.
UPDATING: The context store is being updated.
DELETING: The context store is being deleted.
DELETED: The context store is deleted.
Tags (list) --
The tags associated with the context store.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Returns the context stores in your account. You can optionally return only the context stores in a specific global network.
See also: AWS API Documentation
Request Syntax
client.list_context_stores(
GlobalNetworkId='string',
MaxResults=123,
NextToken='string'
)
string
The ID of a global network. If you specify this parameter, only the context stores in the global network are returned.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'ContextStores': [
{
'GlobalNetworkId': 'string',
'ContextStoreId': 'string',
'ContextStoreArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ContextStores (list) --
The context stores.
(dict) --
Describes a context store.
GlobalNetworkId (string) --
The ID of the global network that the context store belongs to.
ContextStoreId (string) --
The ID of the context store.
ContextStoreArn (string) --
The Amazon Resource Name (ARN) of the context store.
Description (string) --
The description of the context store.
CreatedAt (datetime) --
The date and time that the context store was created.
State (string) --
The state of the context store. The possible values are the following:
PENDING: The context store is being created.
AVAILABLE: The context store is ready to use.
UPDATING: The context store is being updated.
DELETING: The context store is being deleted.
DELETED: The context store is deleted.
Tags (list) --
The tags associated with the context store.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
NextToken (string) --
The token for the next page of results.
Returns the current version of the context entries of a context store. The context store must be in the AVAILABLE state.
See also: AWS API Documentation
Request Syntax
client.get_context_version(
ContextStoreId='string'
)
string
[REQUIRED]
The ID of the context store.
dict
Response Syntax
{
'VersionId': 'string'
}
Response Structure
(dict) --
VersionId (string) --
The current version of the context entries.
Returns the context entries of a context store, and the version of the context entries. To get the context entries that were added or removed after this version, specify the returned VersionId in a ListContextChanges request. The context store must be in the AVAILABLE state.
See also: AWS API Documentation
Request Syntax
client.list_contexts(
ContextStoreId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the context store.
integer
The maximum number of results to return.
string
The token for the next page of results.
dict
Response Syntax
{
'Contexts': [
{
'ContextId': 'string',
'ContextType': 'string',
'SegmentType': 'string',
'PublicId': 'string',
'Region': 'string',
'AvailabilityZone': 'string',
'AttachmentType': 'string'
},
],
'NextToken': 'string',
'VersionId': 'string'
}
Response Structure
(dict) --
Contexts (list) --
The context entries.
(dict) --
Describes a context entry in a context store. A context entry describes a resource, such as a security group, subnet, or attachment.
ContextId (string) --
The ID of the context entry.
ContextType (string) --
The type of the context entry, for example SegmentId, Subnet, or Attachment.
SegmentType (string) --
The type of the segment, for example SecurityGroup. Network Manager returns this value only when the context type is SegmentId.
PublicId (string) --
The ID of the resource, for example a security group ID, subnet ID, or transit gateway attachment ID.
Region (string) --
The Amazon Web Services Region of the resource.
AvailabilityZone (string) --
The ID of the Availability Zone of the resource, for example use1-az2. Network Manager returns this value only when the context type is Subnet.
AttachmentType (string) --
The type of the attachment, for example VPC. Network Manager returns this value only when the context type is Attachment.
NextToken (string) --
The token for the next page of results.
VersionId (string) --
The version of the returned context entries. All pages of the same request return the same version.
Returns information about a context store.
See also: AWS API Documentation
Request Syntax
client.get_context_store(
ContextStoreId='string'
)
string
[REQUIRED]
The ID of the context store.
dict
Response Syntax
{
'ContextStore': {
'GlobalNetworkId': 'string',
'ContextStoreId': 'string',
'ContextStoreArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ContextStore (dict) --
Information about the context store.
GlobalNetworkId (string) --
The ID of the global network that the context store belongs to.
ContextStoreId (string) --
The ID of the context store.
ContextStoreArn (string) --
The Amazon Resource Name (ARN) of the context store.
Description (string) --
The description of the context store.
CreatedAt (datetime) --
The date and time that the context store was created.
State (string) --
The state of the context store. The possible values are the following:
PENDING: The context store is being created.
AVAILABLE: The context store is ready to use.
UPDATING: The context store is being updated.
DELETING: The context store is being deleted.
DELETED: The context store is deleted.
Tags (list) --
The tags associated with the context store.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Associates a transit gateway with a context store. The transit gateway must be registered with the global network of the context store, and can't be associated with more than one context store. The context store must be in the AVAILABLE state.
The association is in the ASSOCIATING state when it's created, and changes to ASSOCIATED when it's complete.
See also: AWS API Documentation
Request Syntax
client.associate_context_store(
ContextStoreId='string',
TransitGatewayArn='string'
)
string
[REQUIRED]
The ID of the context store.
string
The Amazon Resource Name (ARN) of the transit gateway to associate with the context store.
dict
Response Syntax
{
'ContextStoreAssociation': {
'ContextStoreId': 'string',
'TransitGatewayArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'ASSOCIATING'|'ASSOCIATED'|'DISASSOCIATING'|'FAILED'
}
}
Response Structure
(dict) --
ContextStoreAssociation (dict) --
Information about the context store association.
ContextStoreId (string) --
The ID of the context store.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
CreatedAt (datetime) --
The date and time that the association was created.
State (string) --
The state of the association. The possible values are the following:
ASSOCIATING: The transit gateway is being associated with the context store.
ASSOCIATED: The transit gateway is associated with the context store.
DISASSOCIATING: The transit gateway is being disassociated from the context store.
FAILED: The association failed. To remove it, disassociate the transit gateway.
Deletes a context store. The context store must be in the AVAILABLE state. You must disassociate all transit gateways from the context store before you can delete it.
See also: AWS API Documentation
Request Syntax
client.delete_context_store(
ContextStoreId='string'
)
string
[REQUIRED]
The ID of the context store to delete.
dict
Response Syntax
{
'ContextStore': {
'GlobalNetworkId': 'string',
'ContextStoreId': 'string',
'ContextStoreArn': 'string',
'Description': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'PENDING'|'AVAILABLE'|'UPDATING'|'DELETING'|'DELETED',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
ContextStore (dict) --
Information about the context store.
GlobalNetworkId (string) --
The ID of the global network that the context store belongs to.
ContextStoreId (string) --
The ID of the context store.
ContextStoreArn (string) --
The Amazon Resource Name (ARN) of the context store.
Description (string) --
The description of the context store.
CreatedAt (datetime) --
The date and time that the context store was created.
State (string) --
The state of the context store. The possible values are the following:
PENDING: The context store is being created.
AVAILABLE: The context store is ready to use.
UPDATING: The context store is being updated.
DELETING: The context store is being deleted.
DELETED: The context store is deleted.
Tags (list) --
The tags associated with the context store.
(dict) --
Describes a tag.
Key (string) --
The tag key.
Constraints: Maximum length of 128 characters.
Value (string) --
The tag value.
Constraints: Maximum length of 256 characters.
Disassociates a transit gateway from a context store. The association must be in the ASSOCIATED or FAILED state. The association stays in the DISASSOCIATING state until the disassociation completes.
See also: AWS API Documentation
Request Syntax
client.disassociate_context_store(
ContextStoreId='string',
TransitGatewayArn='string'
)
string
[REQUIRED]
The ID of the context store.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway to disassociate from the context store.
dict
Response Syntax
{
'ContextStoreAssociation': {
'ContextStoreId': 'string',
'TransitGatewayArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'ASSOCIATING'|'ASSOCIATED'|'DISASSOCIATING'|'FAILED'
}
}
Response Structure
(dict) --
ContextStoreAssociation (dict) --
Information about the context store association.
ContextStoreId (string) --
The ID of the context store.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
CreatedAt (datetime) --
The date and time that the association was created.
State (string) --
The state of the association. The possible values are the following:
ASSOCIATING: The transit gateway is being associated with the context store.
ASSOCIATED: The transit gateway is associated with the context store.
DISASSOCIATING: The transit gateway is being disassociated from the context store.
FAILED: The association failed. To remove it, disassociate the transit gateway.
Returns information about the association between a context store and a transit gateway.
See also: AWS API Documentation
Request Syntax
client.get_context_store_association(
ContextStoreId='string',
TransitGatewayArn='string'
)
string
[REQUIRED]
The ID of the context store.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the transit gateway.
dict
Response Syntax
{
'ContextStoreAssociation': {
'ContextStoreId': 'string',
'TransitGatewayArn': 'string',
'CreatedAt': datetime(2015, 1, 1),
'State': 'ASSOCIATING'|'ASSOCIATED'|'DISASSOCIATING'|'FAILED'
}
}
Response Structure
(dict) --
ContextStoreAssociation (dict) --
Information about the context store association.
ContextStoreId (string) --
The ID of the context store.
TransitGatewayArn (string) --
The Amazon Resource Name (ARN) of the transit gateway.
CreatedAt (datetime) --
The date and time that the association was created.
State (string) --
The state of the association. The possible values are the following:
ASSOCIATING: The transit gateway is being associated with the context store.
ASSOCIATED: The transit gateway is associated with the context store.
DISASSOCIATING: The transit gateway is being disassociated from the context store.
FAILED: The association failed. To remove it, disassociate the transit gateway.