delete_attachment¶

NetworkManager.Client.delete_attachment(**kwargs)¶

Deletes an attachment. Supports all attachment types.

Request Syntax

response = client.delete_attachment(
    AttachmentId='string'
)

Parameters

AttachmentId (string) --

[REQUIRED]

The ID of the attachment to delete.

Return type

dict

Returns

Response Syntax

{
    'Attachment': {
        'CoreNetworkId': 'string',
        'CoreNetworkArn': 'string',
        'AttachmentId': 'string',
        'OwnerAccountId': 'string',
        'AttachmentType': 'CONNECT'|'SITE_TO_SITE_VPN'|'VPC'|'TRANSIT_GATEWAY_ROUTE_TABLE',
        'State': 'REJECTED'|'PENDING_ATTACHMENT_ACCEPTANCE'|'CREATING'|'FAILED'|'AVAILABLE'|'UPDATING'|'PENDING_NETWORK_UPDATE'|'PENDING_TAG_ACCEPTANCE'|'DELETING',
        'EdgeLocation': 'string',
        'ResourceArn': 'string',
        'AttachmentPolicyRuleNumber': 123,
        'SegmentName': 'string',
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'ProposedSegmentChange': {
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ],
            'AttachmentPolicyRuleNumber': 123,
            'SegmentName': 'string'
        },
        'CreatedAt': datetime(2015, 1, 1),
        'UpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- Attachment (dict) --
  Information about the deleted attachment.
  - CoreNetworkId (string) --
    The ID of a core network.
  - CoreNetworkArn (string) --
    The ARN of a core network.
  - AttachmentId (string) --
    The ID of the attachment.
  - OwnerAccountId (string) --
    The ID of the attachment account owner.
  - AttachmentType (string) --
    The type of attachment.
  - State (string) --
    The state of the attachment.
  - EdgeLocation (string) --
    The Region where the edge is located.
  - ResourceArn (string) --
    The attachment resource ARN.
  - AttachmentPolicyRuleNumber (integer) --
    The policy rule number associated with the attachment.
  - SegmentName (string) --
    The name of the segment attachment.
  - Tags (list) --
    The tags associated with the attachment.
    - (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.
  - ProposedSegmentChange (dict) --
    The attachment to move from one segment to another.
    - Tags (list) --
      The list of key-value tags that changed for the segment.
      - (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.
    - AttachmentPolicyRuleNumber (integer) --
      The rule number in the policy document that applies to this change.
    - SegmentName (string) --
      The name of the segment to change.
  - CreatedAt (datetime) --
    The timestamp when the attachment was created.
  - UpdatedAt (datetime) --
    The timestamp when the attachment was last updated.

Exceptions

NetworkManager.Client.exceptions.ValidationException
NetworkManager.Client.exceptions.AccessDeniedException
NetworkManager.Client.exceptions.ResourceNotFoundException
NetworkManager.Client.exceptions.ConflictException
NetworkManager.Client.exceptions.ThrottlingException
NetworkManager.Client.exceptions.InternalServerException

Table Of Contents

delete_attachment¶