:doc:`EC2 <../../ec2>` / Client / modify_verified_access_endpoint

*******************************
modify_verified_access_endpoint
*******************************



.. py:method:: EC2.Client.modify_verified_access_endpoint(**kwargs)

  

  Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/ModifyVerifiedAccessEndpoint>`_  


  **Request Syntax**
  ::

    response = client.modify_verified_access_endpoint(
        VerifiedAccessEndpointId='string',
        VerifiedAccessGroupId='string',
        LoadBalancerOptions={
            'SubnetIds': [
                'string',
            ],
            'Protocol': 'http'|'https'|'tcp',
            'Port': 123,
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        },
        NetworkInterfaceOptions={
            'Protocol': 'http'|'https'|'tcp',
            'Port': 123,
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        },
        Description='string',
        ClientToken='string',
        DryRun=True|False,
        RdsOptions={
            'SubnetIds': [
                'string',
            ],
            'Port': 123,
            'RdsEndpoint': 'string'
        },
        CidrOptions={
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        }
    )
    
  :type VerifiedAccessEndpointId: string
  :param VerifiedAccessEndpointId: **[REQUIRED]** 

    The ID of the Verified Access endpoint.

    

  
  :type VerifiedAccessGroupId: string
  :param VerifiedAccessGroupId: 

    The ID of the Verified Access group.

    

  
  :type LoadBalancerOptions: dict
  :param LoadBalancerOptions: 

    The load balancer details if creating the Verified Access endpoint as ``load-balancer``type.

    

  
    - **SubnetIds** *(list) --* 

      The IDs of the subnets.

      

    
      - *(string) --* 

      
  
    - **Protocol** *(string) --* 

      The IP protocol.

      

    
    - **Port** *(integer) --* 

      The IP port number.

      

    
    - **PortRanges** *(list) --* 

      The port ranges.

      

    
      - *(dict) --* 

        Describes the port range for a Verified Access endpoint.

        

      
        - **FromPort** *(integer) --* 

          The start of the port range.

          

        
        - **ToPort** *(integer) --* 

          The end of the port range.

          

        
      
  
  
  :type NetworkInterfaceOptions: dict
  :param NetworkInterfaceOptions: 

    The network interface options.

    

  
    - **Protocol** *(string) --* 

      The IP protocol.

      

    
    - **Port** *(integer) --* 

      The IP port number.

      

    
    - **PortRanges** *(list) --* 

      The port ranges.

      

    
      - *(dict) --* 

        Describes the port range for a Verified Access endpoint.

        

      
        - **FromPort** *(integer) --* 

          The start of the port range.

          

        
        - **ToPort** *(integer) --* 

          The end of the port range.

          

        
      
  
  
  :type Description: string
  :param Description: 

    A description for the Verified Access endpoint.

    

  
  :type ClientToken: string
  :param ClientToken: 

    A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html>`__.

    This field is autopopulated if not provided.

  
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

  
  :type RdsOptions: dict
  :param RdsOptions: 

    The RDS options.

    

  
    - **SubnetIds** *(list) --* 

      The IDs of the subnets.

      

    
      - *(string) --* 

      
  
    - **Port** *(integer) --* 

      The port.

      

    
    - **RdsEndpoint** *(string) --* 

      The RDS endpoint.

      

    
  
  :type CidrOptions: dict
  :param CidrOptions: 

    The CIDR options.

    

  
    - **PortRanges** *(list) --* 

      The port ranges.

      

    
      - *(dict) --* 

        Describes the port range for a Verified Access endpoint.

        

      
        - **FromPort** *(integer) --* 

          The start of the port range.

          

        
        - **ToPort** *(integer) --* 

          The end of the port range.

          

        
      
  
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VerifiedAccessEndpoint': {
              'VerifiedAccessInstanceId': 'string',
              'VerifiedAccessGroupId': 'string',
              'VerifiedAccessEndpointId': 'string',
              'ApplicationDomain': 'string',
              'EndpointType': 'load-balancer'|'network-interface'|'rds'|'cidr',
              'AttachmentType': 'vpc',
              'DomainCertificateArn': 'string',
              'EndpointDomain': 'string',
              'DeviceValidationDomain': 'string',
              'SecurityGroupIds': [
                  'string',
              ],
              'LoadBalancerOptions': {
                  'Protocol': 'http'|'https'|'tcp',
                  'Port': 123,
                  'LoadBalancerArn': 'string',
                  'SubnetIds': [
                      'string',
                  ],
                  'PortRanges': [
                      {
                          'FromPort': 123,
                          'ToPort': 123
                      },
                  ]
              },
              'NetworkInterfaceOptions': {
                  'NetworkInterfaceId': 'string',
                  'Protocol': 'http'|'https'|'tcp',
                  'Port': 123,
                  'PortRanges': [
                      {
                          'FromPort': 123,
                          'ToPort': 123
                      },
                  ]
              },
              'Status': {
                  'Code': 'pending'|'active'|'updating'|'deleting'|'deleted',
                  'Message': 'string'
              },
              'Description': 'string',
              'CreationTime': 'string',
              'LastUpdatedTime': 'string',
              'DeletionTime': 'string',
              'Tags': [
                  {
                      'Key': 'string',
                      'Value': 'string'
                  },
              ],
              'SseSpecification': {
                  'CustomerManagedKeyEnabled': True|False,
                  'KmsKeyArn': 'string'
              },
              'RdsOptions': {
                  'Protocol': 'http'|'https'|'tcp',
                  'Port': 123,
                  'RdsDbInstanceArn': 'string',
                  'RdsDbClusterArn': 'string',
                  'RdsDbProxyArn': 'string',
                  'RdsEndpoint': 'string',
                  'SubnetIds': [
                      'string',
                  ]
              },
              'CidrOptions': {
                  'Cidr': 'string',
                  'PortRanges': [
                      {
                          'FromPort': 123,
                          'ToPort': 123
                      },
                  ],
                  'Protocol': 'http'|'https'|'tcp',
                  'SubnetIds': [
                      'string',
                  ]
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VerifiedAccessEndpoint** *(dict) --* 

        Details about the Verified Access endpoint.

        
        

        - **VerifiedAccessInstanceId** *(string) --* 

          The ID of the Amazon Web Services Verified Access instance.

          
        

        - **VerifiedAccessGroupId** *(string) --* 

          The ID of the Amazon Web Services Verified Access group.

          
        

        - **VerifiedAccessEndpointId** *(string) --* 

          The ID of the Amazon Web Services Verified Access endpoint.

          
        

        - **ApplicationDomain** *(string) --* 

          The DNS name for users to reach your application.

          
        

        - **EndpointType** *(string) --* 

          The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.

          
        

        - **AttachmentType** *(string) --* 

          The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.

          
        

        - **DomainCertificateArn** *(string) --* 

          The ARN of a public TLS/SSL certificate imported into or created with ACM.

          
        

        - **EndpointDomain** *(string) --* 

          A DNS name that is generated for the endpoint.

          
        

        - **DeviceValidationDomain** *(string) --* 

          Returned if endpoint has a device trust provider attached.

          
        

        - **SecurityGroupIds** *(list) --* 

          The IDs of the security groups for the endpoint.

          
          

          - *(string) --* 
      
        

        - **LoadBalancerOptions** *(dict) --* 

          The load balancer details if creating the Amazon Web Services Verified Access endpoint as ``load-balancer``type.

          
          

          - **Protocol** *(string) --* 

            The IP protocol.

            
          

          - **Port** *(integer) --* 

            The IP port number.

            
          

          - **LoadBalancerArn** *(string) --* 

            The ARN of the load balancer.

            
          

          - **SubnetIds** *(list) --* 

            The IDs of the subnets.

            
            

            - *(string) --* 
        
          

          - **PortRanges** *(list) --* 

            The port ranges.

            
            

            - *(dict) --* 

              Describes a port range.

              
              

              - **FromPort** *(integer) --* 

                The start of the port range.

                
              

              - **ToPort** *(integer) --* 

                The end of the port range.

                
          
        
      
        

        - **NetworkInterfaceOptions** *(dict) --* 

          The options for network-interface type endpoint.

          
          

          - **NetworkInterfaceId** *(string) --* 

            The ID of the network interface.

            
          

          - **Protocol** *(string) --* 

            The IP protocol.

            
          

          - **Port** *(integer) --* 

            The IP port number.

            
          

          - **PortRanges** *(list) --* 

            The port ranges.

            
            

            - *(dict) --* 

              Describes a port range.

              
              

              - **FromPort** *(integer) --* 

                The start of the port range.

                
              

              - **ToPort** *(integer) --* 

                The end of the port range.

                
          
        
      
        

        - **Status** *(dict) --* 

          The endpoint status.

          
          

          - **Code** *(string) --* 

            The status code of the Verified Access endpoint.

            
          

          - **Message** *(string) --* 

            The status message of the Verified Access endpoint.

            
      
        

        - **Description** *(string) --* 

          A description for the Amazon Web Services Verified Access endpoint.

          
        

        - **CreationTime** *(string) --* 

          The creation time.

          
        

        - **LastUpdatedTime** *(string) --* 

          The last updated time.

          
        

        - **DeletionTime** *(string) --* 

          The deletion time.

          
        

        - **Tags** *(list) --* 

          The tags.

          
          

          - *(dict) --* 

            Describes a tag.

            
            

            - **Key** *(string) --* 

              The key of the tag.

               

              Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

              
            

            - **Value** *(string) --* 

              The value of the tag.

               

              Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

              
        
      
        

        - **SseSpecification** *(dict) --* 

          The options in use for server side encryption.

          
          

          - **CustomerManagedKeyEnabled** *(boolean) --* 

            Indicates whether customer managed KMS keys are in use for server side encryption.

             

            Valid values: ``True`` | ``False``

            
          

          - **KmsKeyArn** *(string) --* 

            The ARN of the KMS key.

            
      
        

        - **RdsOptions** *(dict) --* 

          The options for an RDS endpoint.

          
          

          - **Protocol** *(string) --* 

            The protocol.

            
          

          - **Port** *(integer) --* 

            The port.

            
          

          - **RdsDbInstanceArn** *(string) --* 

            The ARN of the RDS instance.

            
          

          - **RdsDbClusterArn** *(string) --* 

            The ARN of the DB cluster.

            
          

          - **RdsDbProxyArn** *(string) --* 

            The ARN of the RDS proxy.

            
          

          - **RdsEndpoint** *(string) --* 

            The RDS endpoint.

            
          

          - **SubnetIds** *(list) --* 

            The IDs of the subnets.

            
            

            - *(string) --* 
        
      
        

        - **CidrOptions** *(dict) --* 

          The options for a CIDR endpoint.

          
          

          - **Cidr** *(string) --* 

            The CIDR.

            
          

          - **PortRanges** *(list) --* 

            The port ranges.

            
            

            - *(dict) --* 

              Describes a port range.

              
              

              - **FromPort** *(integer) --* 

                The start of the port range.

                
              

              - **ToPort** *(integer) --* 

                The end of the port range.

                
          
        
          

          - **Protocol** *(string) --* 

            The protocol.

            
          

          - **SubnetIds** *(list) --* 

            The IDs of the subnets.

            
            

            - *(string) --* 
        
      
    
  