[ aws . networkmanager ]
get-connect-attachment¶
Description¶
Returns information about a core network Connect attachment.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-connect-attachment
--attachment-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--attachment-id (string)
The ID of the attachment.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Output¶
ConnectAttachment -> (structure)
Details about the Connect attachment.
Attachment -> (structure)
The attachment details.
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.
(structure)
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 -> (structure)
The attachment to move from one segment to another.
Tags -> (list)
The list of key-value tags that changed for the segment.
(structure)
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 -> (timestamp)
The timestamp when the attachment was created.
UpdatedAt -> (timestamp)
The timestamp when the attachment was last updated.
TransportAttachmentId -> (string)
The ID of the transport attachment.
Options -> (structure)
Options for connecting an attachment.
Protocol -> (string)
The protocol used for the attachment connection.