DevOpsAgentService / Client / describe_private_connection

describe_private_connection¶

DevOpsAgentService.Client.describe_private_connection(**kwargs)¶

Retrieves details of an existing Private Connection.

Request Syntax

response = client.describe_private_connection(
    name='string'
)

Parameters:

name (string) –

[REQUIRED]

The name of the Private Connection.

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'type': 'SELF_MANAGED'|'SERVICE_MANAGED',
    'resourceGatewayId': 'string',
    'hostAddress': 'string',
    'vpcId': 'string',
    'resourceConfigurationId': 'string',
    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
    'certificateExpiryTime': datetime(2015, 1, 1),
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –

Output containing the Private Connection details.
- name (string) –
  
  The name of the Private Connection.
- type (string) –
  
  The type of the Private Connection.
- resourceGatewayId (string) –
  
  The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
- hostAddress (string) –
  
  IP address or DNS name of the target resource. Only present for service-managed Private Connections.
- vpcId (string) –
  
  VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
- resourceConfigurationId (string) –
  
  The Resource Configuration ARN. Only present for self-managed Private Connections.
- status (string) –
  
  The status of the Private Connection.
- certificateExpiryTime (datetime) –
  
  The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
- tags (dict) –
  
  Tags associated with the Private Connection.
  - (string) –
    
    Tag key string.
    - (string) –
      
      Tag value string.

Exceptions

DevOpsAgentService.Client.exceptions.ValidationException
DevOpsAgentService.Client.exceptions.ContentSizeExceededException
DevOpsAgentService.Client.exceptions.ServiceQuotaExceededException
DevOpsAgentService.Client.exceptions.ConflictException
DevOpsAgentService.Client.exceptions.InternalServerException
DevOpsAgentService.Client.exceptions.AccessDeniedException
DevOpsAgentService.Client.exceptions.ResourceNotFoundException
DevOpsAgentService.Client.exceptions.ThrottlingException
DevOpsAgentService.Client.exceptions.InvalidParameterException