BedrockAgentCoreControl / Client / get_browser

get_browser¶

BedrockAgentCoreControl.Client.get_browser(**kwargs)¶

Gets information about a custom browser.

Request Syntax

response = client.get_browser(
    browserId='string'
)

Parameters:

browserId (string) –

[REQUIRED]

The unique identifier of the browser to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'browserId': 'string',
    'browserArn': 'string',
    'name': 'string',
    'description': 'string',
    'executionRoleArn': 'string',
    'networkConfiguration': {
        'networkMode': 'PUBLIC'|'VPC',
        'vpcConfig': {
            'securityGroups': [
                'string',
            ],
            'subnets': [
                'string',
            ]
        }
    },
    'recording': {
        'enabled': True|False,
        's3Location': {
            'bucket': 'string',
            'prefix': 'string',
            'versionId': 'string'
        }
    },
    'browserSigning': {
        'enabled': True|False
    },
    'enterprisePolicies': [
        {
            'location': {
                's3': {
                    'bucket': 'string',
                    'prefix': 'string',
                    'versionId': 'string'
                }
            },
            'type': 'MANAGED'|'RECOMMENDED'
        },
    ],
    'certificates': [
        {
            'location': {
                'secretsManager': {
                    'secretArn': 'string'
                }
            }
        },
    ],
    'status': 'CREATING'|'CREATE_FAILED'|'READY'|'DELETING'|'DELETE_FAILED'|'DELETED',
    'failureReason': 'string',
    'createdAt': datetime(2015, 1, 1),
    'lastUpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- browserId (string) –
  
  The unique identifier of the browser.
- browserArn (string) –
  
  The Amazon Resource Name (ARN) of the browser.
- name (string) –
  
  The name of the browser.
- description (string) –
  
  The description of the browser.
- executionRoleArn (string) –
  
  The IAM role ARN that provides permissions for the browser.
- networkConfiguration (dict) –
  
  The network configuration for a browser. This structure defines how the browser connects to the network.
  - networkMode (string) –
    
    The network mode for the browser. This field specifies how the browser connects to the network.
  - vpcConfig (dict) –
    
    VpcConfig for the Agent.
    - securityGroups (list) –
      
      The security groups associated with the VPC configuration.
      - (string) –
    - subnets (list) –
      
      The subnets associated with the VPC configuration.
      - (string) –
- recording (dict) –
  
  The recording configuration for a browser. This structure defines how browser sessions are recorded.
  - enabled (boolean) –
    
    Indicates whether recording is enabled for the browser. When set to true, browser sessions are recorded.
  - s3Location (dict) –
    
    The Amazon S3 location where browser recordings are stored. This location contains the recorded browser sessions.
    - bucket (string) –
      
      The name of the Amazon S3 bucket. This bucket contains the stored data.
    - prefix (string) –
      
      The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.
    - versionId (string) –
      
      The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.
- browserSigning (dict) –
  
  The browser signing configuration that shows whether cryptographic agent identification is enabled for web bot authentication.
  - enabled (boolean) –
    
    Indicates whether browser signing is currently enabled for cryptographic agent identification using HTTP message signatures.
- enterprisePolicies (list) –
  
  The list of enterprise policy files configured for the browser.
  - (dict) –
    
    Browser enterprise policy configuration.
    - location (dict) –
      
      The location of the enterprise policy file.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: s3. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - s3 (dict) –
        
        The Amazon S3 location for storing data. This structure defines where in Amazon S3 data is stored.
        
        bucket (string) –
        
        The name of the Amazon S3 bucket. This bucket contains the stored data.
        
        prefix (string) –
        
        The prefix for objects in the Amazon S3 bucket. This prefix is added to the object keys to organize the data.
        
        versionId (string) –
        
        The version ID of the Amazon Amazon S3 object. If not specified, the latest version of the object is used.
    - type (string) –
      
      The type of browser enterprise policy. Available values are MANAGED and RECOMMENDED.
- certificates (list) –
  
  The list of certificates configured for the browser.
  - (dict) –
    
    A certificate to install in the browser or code interpreter.
    - location (dict) –
      
      The location of the certificate.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: secretsManager. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - secretsManager (dict) –
        
        The Amazon Web Services Secrets Manager location of the certificate.
        
        secretArn (string) –
        
        The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.
- status (string) –
  
  The current status of the browser.
- failureReason (string) –
  
  The reason for failure if the browser is in a failed state.
- createdAt (datetime) –
  
  The timestamp when the browser was created.
- lastUpdatedAt (datetime) –
  
  The timestamp when the browser was last updated.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException