DevOpsAgentService / Client / enable_operator_app

enable_operator_app¶

DevOpsAgentService.Client.enable_operator_app(**kwargs)¶

Enable the Operator App to access the given AgentSpace

Request Syntax

response = client.enable_operator_app(
    agentSpaceId='string',
    authFlow='iam'|'idc'|'idp',
    operatorAppRoleArn='string',
    idcInstanceArn='string',
    issuerUrl='string',
    idpClientId='string',
    idpClientSecret='string',
    provider='string'
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

The unique identifier of the AgentSpace
authFlow (string) –
[REQUIRED]

The authentication flow configured for the operator App. e.g. iam or idc
operatorAppRoleArn (string) –
[REQUIRED]

The IAM role end users assume to access AIDevOps APIs
idcInstanceArn (string) – The IdC instance Arn used to create an IdC auth application
issuerUrl (string) – The OIDC issuer URL of the external Identity Provider
idpClientId (string) – The OIDC client ID for the IdP application
idpClientSecret (string) – The OIDC client secret for the IdP application
provider (string) – The Identity Provider name (e.g., Entra, Okta, Google)

Return type:

dict

Returns:

Response Syntax

{
    'agentSpaceId': 'string',
    'iam': {
        'operatorAppRoleArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    },
    'idc': {
        'operatorAppRoleArn': 'string',
        'idcInstanceArn': 'string',
        'idcApplicationArn': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    },
    'idp': {
        'issuerUrl': 'string',
        'clientId': 'string',
        'operatorAppRoleArn': 'string',
        'provider': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –

Output containing the enabled Operator App configuration.
- agentSpaceId (string) –
  
  The unique identifier of the AgentSpace
- iam (dict) –
  
  Configuration for IAM-based authentication flow for the Operator App.
  - operatorAppRoleArn (string) –
    
    The IAM role end users assume to access AIDevOps APIs
  - createdAt (datetime) –
    
    The timestamp when the Operator App IAM auth flow was enabled.
  - updatedAt (datetime) –
    
    The timestamp when the Operator App IAM auth flow was updated.
- idc (dict) –
  
  Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
  - operatorAppRoleArn (string) –
    
    The IAM role end users assume to access AIDevOps APIs
  - idcInstanceArn (string) –
    
    The IdC instance Arn used to create an IdC auth application
  - idcApplicationArn (string) –
    
    The IdC application Arn created for IdC auth
  - createdAt (datetime) –
    
    The timestamp when the Operator App IdC auth flow was enabled.
  - updatedAt (datetime) –
    
    The timestamp when the Operator App IdC auth flow was updated.
- idp (dict) –
  
  Configuration for external Identity Provider OIDC authentication flow for the Operator App.
  - issuerUrl (string) –
    
    The OIDC issuer URL of the external Identity Provider
  - clientId (string) –
    
    The OIDC client ID for the IdP application
  - operatorAppRoleArn (string) –
    
    The IAM role end users assume to access AIDevOps APIs
  - provider (string) –
    
    The Identity Provider name (e.g., Entra, Okta, Google)
  - createdAt (datetime) –
    
    The timestamp when the Operator App IdP auth flow was enabled.
  - updatedAt (datetime) –
    
    The timestamp when the Operator App IdP auth flow was updated.

Exceptions

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